README
¶
Cole
Cole can use his sixth sense to give you metrics about your Grafana dashboards
Overview
Cole is a lightweight service that handles HTTP logs of Grafana to provide insights about the usage of Grafana instances and expose it through Prometheus metrics.
Grafana router logging dependency
Cole uses its sixth sense by Grafana HTTP logs, and because of this, you need to enable the router_logging to log all HTTP requests (not just errors).
For more information about router logging, please, check the Grafana official documentation.
Metrics Documentation
See the docs directory for more information on the exposed metrics.
Contributing
Contributions are very welcome! See our CONTRIBUTING.md for more information.
Docker images
Docker images are available on Docker Hub.
Building from source
To build Cole from source code, first ensure that you have a working Go environment with version 1.16 or greater installed.
To build the source code you can use the make build, which will compile in
the assets so that Cole can be run from anywhere:
$ mkdir -p $GOPATH/src/github.com/nicolastakashi/cole
$ cd $GOPATH/src/github.com/nicolastakashi/cole
$ git clone https://github.com/nicolastakashi/cole.git
$ cd cole
$ make build
$ ./cole server <args>
The Makefile provides several targets:
- build: build the
cole - fmt: format the source code
- vet: check the source code for common errors
- tests: run unit tests
Documentation
¶
Overview ¶
Copyright © 2021 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories