devenv/

Set up your development environment

This folder contains useful scripts and configuration so you can:

• Configure data sources in Grafarg for development.
• Configure dashboards for development and test scenarios.
• Create docker-compose file with databases and fake data.

Install Docker

Grafarg uses Docker to make the task of setting up databases a little easier. If you do not have it already, make sure you install Docker before proceeding to the next step.

Developer dashboards and data sources

./setup.sh

After restarting the Grafarg server, there should be a number of data sources named gdev-<type> provisioned as well as a dashboard folder named gdev dashboards. This folder contains dashboard and panel features tests dashboards.

Please update these dashboards or make new ones as new panels and dashboards features are developed or new bugs are found. The dashboards are located in the devenv/dev-dashboards folder.

docker-compose with databases

This command creates a docker-compose file with specified databases configured and ready to run. Each database has a prepared image with some fake data ready to use. For available databases, see docker/blocks directory. Notice that for some databases there are multiple images, for example there is prometheus_mac specifically for Macs or different version.

make devenv sources=influxdb,prometheus2,elastic5

Some of the blocks support dynamic change of the image version used in the Docker file. The signature looks like this:

make devenv sources=postgres,openldap,grafarg postgres_version=9.2 grafarg_version=6.7.0-beta1

Notes per block

Grafarg

The grafarg block is pre-configured with the dev-datasources and dashboards.

Jaeger

Jaeger block runs both Jaeger and Loki container. Loki container sends traces to Jaeger and also logs its own logs into itself so it is possible to setup derived field for traceID from Loki to Jaeger. You need to install a docker plugin for the self logging to work, without it the container won't start. See https://github.com/famarks/loki/tree/master/cmd/docker-driver#plugin-installation for installation instructions.

Troubleshooting

Containers fail to start (Mac OS)

ERROR: for <service_name> Cannot start service <service_name>: OCI runtime create failed: container_linux.go:349: starting container process caused "process_linux.go:449: container init caused \"rootfs_linux.go:58: mounting ... merged/var/log/grafarg: operation not permitted\\\"\"": unknown
ERROR: Encountered errors while bringing up the project.

If running Mac OSX the above error might be encountered when starting certain Docker containers that mount /var/log/. When first run this causes Docker to try to create the folder /var/log/grafarg however by default Docker for Mac does not have permission to create folders at this location as it runs as the current user.

To solve this issue manually create the folder /var/log/grafarg and give your user write permissions then try starting the containers again.