Files

82 lines
4.2 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Telegraf InfluxDB Grafana Stack
## What is inside TIG Stack
* [Telegraf](https://hub.docker.com/r/matisq/telegraf/) - Gathers cpu,mem,net,docker data and sends it to InfluxDB
* [InfluxDB](https://hub.docker.com/r/matisq/influxdb/) + volume data - Stores data from Telegraf
* [Grafana](https://hub.docker.com/r/matisq/grafana/) + volume data - Includes one Dashboard (there will be more!) for docker monitoring.
## How to use it?
TIG stack is created for [Rancher](http://rancher.com/). If you are not fammiliar with rancher, please [read](http://rancher.com/rancher/) some docs, because it is really great Docker Orchestration Tool.
To use it add custom [rancher-catalog](https://github.com/matisku/rancher-catalog) to the Rancher configuration, and within only one click, you are able to monitor your Docker Instance automatically!
## What if I don't want to use Rancher?
You can obviously use this stack without Rancher. Just grab [docker-compose.yml](https://raw.githubusercontent.com/matisku/tig-stack/master/docker-compose.yml) file and start your stack as usual.
```bash
$ mkdir tig-stack
$ cd tig-stack
$ curl -OL https://raw.githubusercontent.com/matisku/tig-stack/master/docker-compose.yml
$ docker-compose up -d
```
If needed you can clone this repository and build `tig-stack` locally. For this `docker-compose-circleci.yml` can be used
```bash
$ git clone https://github.com/matisku/tig-stack.git
$ cd tig-stack
$ docker-compose -f docker-compose-circleci.yml up -d
```
If you don't need to install any Grafana plugins use `docker-compose-noplugins.yml`
```bash
$ git clone https://github.com/matisku/tig-stack.git
$ cd tig-stack
$ docker-compose -f docker-compose-noplugins.yml up -d
```
## Additional Info
* By default Grafana will have all available plugins installed.
* To access grafana go to: `http://localhost:30001`
## Environment
### Grafana
`GF_SECURITY_ADMIN_USER` - Admin Username. Default: `admin`
`GF_SECURITY_ADMIN_PASSWORD`- Admin User Password. Default:`admin`
`GF_SECURITY_SECRET_KEY` - Secret key. Default: `grafana`
`GF_USERS_ALLOW_SIGN_UP` - Allow singup to Grafana. Default: `"true"`
`GF_USERS_ALLOW_ORG_CREATE` - Allow user create new Orgs. Default: `"true"`
`GF_AUTH_ANONYMOUS_ENABLED` - Anonymus autthorization enabled. Default: `"true"`
`GF_AUTH_ANONYMOUS_ORG_NAME` - Anonymus defaul Org Name. Default: `grafana`
`GF_DASHBOARDS_JSON_ENABLED` - Dashboards as JSON enabled. Default: `"true"`
`GF_DASHBOARDS_JSON_PATH` - Path where JSON Dashboards are stored. Default: `/opt/grafana`
`GRAFANA_PLUGINS_ENABLED` - Install all available Grafana Plugins. Default: `true`
### InfluxDB
`INFLUX_DATABASE` - IndluxDB Database Name. Default: `"telegraf"`
`INLFUX_ADMIN_USER` - IndluxDB Admin Username. Default: `"grafana"`
`INFLUX_ADMIN_PASS` - InfluxDB Admin Password. Default: `"grafana"`
### Telegraf
`HOST_NAME` - Telegraf Default Hostane. Default: `"telegraf"`
`INFLUXDB_HOST` - IndluxDB Database Host. Default: `"influxdb"`
`INFLUXDB_PORT` - InfluxDB Default Port. Default: `"8086"`
`DATABASE` - InfluxDB Database where telegraf stores data. Default: `"telegraf"`
## Ports
Grafana:
  - `3000` - in Docker
  - `3001` - on Host
InfluxDB:
  - `8083`
  - `8086`
## License
Copyright © 2016-2018 Mateusz Trojak. See LICENSE for details.
## TODO
* Add more Grafs
## Metadata
* [![Build Status](https://travis-ci.org/matisku/tig-stack.svg?branch=master)](https://travis-ci.org/matisku/tig-stack) [![CircleCI](https://circleci.com/gh/matisku/tig-stack.svg?style=svg)](https://circleci.com/gh/matisku/tig-stack)
* [matisq/telegraf](https://hub.docker.com/r/matisq/telegraf/) [![](https://images.microbadger.com/badges/image/matisq/telegraf.svg)](http://microbadger.com/images/matisq/telegraf "Get your own image badge on microbadger.com")
* [matisq/influxdb](https://hub.docker.com/r/matisq/influxdb/) [![](https://images.microbadger.com/badges/image/matisq/influxdb.svg)](http://microbadger.com/images/matisq/influxdb "Get your own image badge on microbadger.com")
* [matisq/grafana](https://hub.docker.com/r/matisq/grafana/) [![](https://images.microbadger.com/badges/image/matisq/grafana.svg)](http://microbadger.com/images/matisq/grafana "Get your own image badge on microbadger.com")