darkroom

command module
Version: v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 9, 2021 License: MIT Imports: 2 Imported by: 0

README

Darkroom - Yet Another Image Proxy

build status Coverage Status Docs latest GoDoc Go Report Card GolangCI GitHub Release Mentioned in Awesome Go

Introduction

Darkroom combines the storage backend and the image processor and acts as an Image Proxy on your image source.
You may implement your own Storage and Processor interfaces to gain custom functionality while still keeping other Darkroom Server functionality.
The native implementations focus on speed and resiliency.

Features

Darkroom supports several image operations which are documented here.

Installation

go get -u github.com/gojek/darkroom

Other ways to run can be found here.

Metrics Support

Darkroom supports Prometheus and StatsD for tracking and monitoring metrics. You need to specify the metrics system by adding an environment variable, METRICS_SYSTEM=prometheus/statsd

Prometheus

The application exposes the metrics at "http://<application_url>/metrics" endpoint. Since it's a pull based system, Prometheus server that is set up from docker-compose scrapes metrics from the application endpoint and its configuration can be changed in prometheus.yml.

StatsD

In order to use StatsD as your metrics system, you also need to add the following env variables,

METRICS_STATSD_STATSDADDR=hostname:port
METRICS_STATSD_PREFIX=client-prefix
METRICS_STATSD_SAMPLERATE=sample-rate
METRICS_STATSD_FLUSHBYTES=flushbytes

These are used to set up the StatsD client.

Grafana

Darkroom currently supports grafana provisioning for Prometheus based metrics.

Grafana is preconfigured with dashboards and Prometheus as the default data source:

  • Name: Prometheus
  • Type: Prometheus
  • Url: http://prometheus:9090
  • Access: proxy

Visualization of Darkroom metrics(prometheus) on Grafana:

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Darkroom.

License

Darkroom is MIT licensed.

Documentation

Overview

Darkroom is an image proxy that works with different storage backends and different image processing engines. It also gives special attention to resiliency and speed. There is also support for inbuilt metrics collection for statsd.

Source Files

Directories

Path Synopsis
pkg
logger
Package logger wraps some commonly used functions from zap.Logger and zap.SugaredLogger and maintains a single instance of the logger
Package logger wraps some commonly used functions from zap.Logger and zap.SugaredLogger and maintains a single instance of the logger
router
Package router has the default routes information
Package router has the default routes information
server
Package server holds the structs and methods containing the logic to spin up the api server
Package server holds the structs and methods containing the logic to spin up the api server
service
Package service contains the service definitions used by the handler
Package service contains the service definitions used by the handler
storage
Package storage contains the Storage interface and its various implementations for different backends.
Package storage contains the Storage interface and its various implementations for different backends.
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL