Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gojek/darkroom

Last synced: 14 days ago
JSON representation

Host: GitHub
URL: https://github.com/gojek/darkroom
Owner: gojek
License: mit
Created: 2019-07-01T10:17:08.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-19T11:27:59.000Z (7 months ago)
Last Synced: 2024-07-31T20:52:00.992Z (3 months ago)
Language: Go
Homepage: https://www.gojek.io/darkroom/
Size: 3.66 MB
Stars: 223
Watchers: 11
Forks: 38
Open Issues: 11
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-go - darkroom - An image proxy with changeable storage backends and image processing engines with focus on speed and resiliency. (Images / Search and Analytic Databases)
awesome-go-extra - darkroom - 07-01T10:17:08Z|2022-04-16T21:41:01Z| (Images / Advanced Console UIs)

README

        # Darkroom - Yet Another Image Proxy



[![build status](https://travis-ci.com/gojek/darkroom.svg?branch=master)](https://travis-ci.com/gojek/darkroom)

[![Coverage Status](https://coveralls.io/repos/github/gojek/darkroom/badge.svg?branch=master)](https://coveralls.io/github/gojek/darkroom?branch=master)

[![Docs latest](https://img.shields.io/badge/Docs-latest-blue.svg)](https://gojek.github.io/darkroom/)

[![GoDoc](https://godoc.org/github.com/gojek/darkroom?status.svg)](https://godoc.org/github.com/gojek/darkroom)

[![Go Report Card](https://goreportcard.com/badge/github.com/gojek/darkroom)](https://goreportcard.com/report/github.com/gojek/darkroom)

[![GolangCI](https://golangci.com/badges/github.com/gojek/darkroom.svg)](https://golangci.com)

[![GitHub Release](https://img.shields.io/github/release/gojek/darkroom.svg?style=flat)](https://github.com/gojek/darkroom/releases)

[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)  

## Introduction

[Darkroom](https://gojek.github.io/darkroom/) combines the [storage backend](pkg/storage) and the [image processor](pkg/processor) and acts as an `Image Proxy` on your image source.  

You may [implement](https://gojek.github.io/darkroom/docs/customization#custom-storage-example) 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](https://gojek.github.io/darkroom/docs/usage/size).

## Installation

```bash

go get -u github.com/gojek/darkroom

```

Other ways to run can be found [here](https://gojek.github.io/darkroom/docs/getting-started#running-the-image-proxy-service).

## 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:///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](./CONTRIBUTING.md) 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](./LICENSE).