README
¶
Grafana 
Website |
Twitter |
IRC |
Slack |
Email
Grafana is an open source, feature rich metrics dashboard and graph editor for Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB.
Features
Graphite Target Editor
- Graphite target expression parser
- Feature rich query composer
- Quickly add and edit functions & parameters
- Templated queries
- See it in action
Graphing
- Fast rendering, even over large timespans
- Click and drag to zoom
- Multiple Y-axis, logarithmic scales
- Bars, Lines, Points
- Smart Y-axis formatting
- Series toggles & color selector
- Legend values, and formatting options
- Grid thresholds, axis labels
- Annotations
- Any panel can be rendered to PNG (server side using phantomjs)
Dashboards
- Create, edit, save & search dashboards
- Change column spans and row heights
- Drag and drop panels to rearrange
- Templating
- Scripted dashboards
- Dashboard playlists
- Time range controls
- Share snapshots publicly
Elasticsearch
- Feature rich query editor UI
InfluxDB
- Use InfluxDB as a metric data source, annotation source
- Query editor with series and column typeahead, easy group by and function selection
OpenTSDB
- Use as metric data source
- Query editor with metric name typeahead and tag filtering
Requirements
There are no dependencies except an external time series data store. For dashboards and user accounts Grafana can use an embedded database (sqlite3) or you can use an external SQL data base like MySQL or Postgres.
Installation
Head to grafana.org and download the latest release.
If you have any problems please read the troubleshooting guide.
Documentation & Support
Be sure to read the getting started guide and the other feature guides.
Run from master
If you want to build a package yourself, or contribute. Here is a guide for how to do that. You can always find the latest master builds here
Dependencies
- Go 1.5
- NodeJS
- Godep
Get Code
go get github.com/grafana/grafana
Building the backend
Replace X.Y.Z by actual version number.
cd $GOPATH/src/github.com/grafana/grafana
go run build.go setup (only needed once to install godep)
godep restore (will pull down all golang lib dependencies in your current GOPATH)
go run build.go build
Building frontend assets
To build less to css for the frontend you will need a recent version of of node (v0.12.0), npm (v2.5.0) and grunt (v0.4.5). Run the following:
npm install
npm run build
Recompile backend on source change
To rebuild on source change (requires that you executed godep restore)
go get github.com/Unknwon/bra
bra run
Running
./bin/grafana-server
Open grafana in your browser (default http://localhost:3000) and login with admin user (default user/pass = admin/admin).
Dev config
Create a custom.ini in the conf directory to override default configuration options. You only need to add the options you want to override. Config files are applied in the order of:
- grafana.ini
- dev.ini (if found)
- custom.ini
Create a pull request
Before or after you create a pull request, sign the contributor license agreement.
Contribute
If you have any idea for an improvement or found a bug do not hesitate to open an issue. And if you have time clone this repo and submit a pull request and help me make Grafana the kickass metrics & devops dashboard we all dream about!
Before creating a pull request be sure that "grunt test" runs without any style or unit test errors, also please sign the CLA
License
Grafana is distributed under Apache 2.0 License. Work in progress Grafana 2.0 (with included Grafana backend)
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/github.com/Unknwon/com
Package com is an open source project for commonly used functions for the Go programming language.
|
Package com is an open source project for commonly used functions for the Go programming language. |
|
_workspace/src/github.com/aws/aws-sdk-go/aws
Package aws provides core functionality for making requests to AWS services.
|
Package aws provides core functionality for making requests to AWS services. |
|
_workspace/src/github.com/aws/aws-sdk-go/aws/awserr
Package awserr represents API error interface accessors for the SDK.
|
Package awserr represents API error interface accessors for the SDK. |
|
_workspace/src/github.com/aws/aws-sdk-go/aws/credentials
Package credentials provides credential retrieval and management The Credentials is the primary method of getting access to and managing credentials Values.
|
Package credentials provides credential retrieval and management The Credentials is the primary method of getting access to and managing credentials Values. |
|
_workspace/src/github.com/aws/aws-sdk-go/aws/credentials/stscreds
Package stscreds are credential Providers to retrieve STS AWS credentials.
|
Package stscreds are credential Providers to retrieve STS AWS credentials. |
|
_workspace/src/github.com/aws/aws-sdk-go/aws/defaults
Package defaults is a collection of helpers to retrieve the SDK's default configuration and handlers.
|
Package defaults is a collection of helpers to retrieve the SDK's default configuration and handlers. |
|
_workspace/src/github.com/aws/aws-sdk-go/aws/ec2metadata
Package ec2metadata provides the client for making API calls to the EC2 Metadata service.
|
Package ec2metadata provides the client for making API calls to the EC2 Metadata service. |
|
_workspace/src/github.com/aws/aws-sdk-go/aws/session
Package session provides a way to create service clients with shared configuration and handlers.
|
Package session provides a way to create service clients with shared configuration and handlers. |
|
_workspace/src/github.com/aws/aws-sdk-go/internal/endpoints
Package endpoints validates regional endpoints for services.
|
Package endpoints validates regional endpoints for services. |
|
_workspace/src/github.com/aws/aws-sdk-go/internal/protocol/ec2query
Package ec2query provides serialisation of AWS EC2 requests and responses.
|
Package ec2query provides serialisation of AWS EC2 requests and responses. |
|
_workspace/src/github.com/aws/aws-sdk-go/internal/protocol/query
Package query provides serialisation of AWS query requests, and responses.
|
Package query provides serialisation of AWS query requests, and responses. |
|
_workspace/src/github.com/aws/aws-sdk-go/internal/protocol/rest
Package rest provides RESTful serialisation of AWS requests and responses.
|
Package rest provides RESTful serialisation of AWS requests and responses. |
|
_workspace/src/github.com/aws/aws-sdk-go/internal/protocol/xml/xmlutil
Package xmlutil provides XML serialisation of AWS requests and responses.
|
Package xmlutil provides XML serialisation of AWS requests and responses. |
|
_workspace/src/github.com/aws/aws-sdk-go/internal/signer/v4
Package v4 implements signing for AWS V4 signer
|
Package v4 implements signing for AWS V4 signer |
|
_workspace/src/github.com/aws/aws-sdk-go/private/endpoints
Package endpoints validates regional endpoints for services.
|
Package endpoints validates regional endpoints for services. |
|
_workspace/src/github.com/aws/aws-sdk-go/private/protocol/ec2query
Package ec2query provides serialisation of AWS EC2 requests and responses.
|
Package ec2query provides serialisation of AWS EC2 requests and responses. |
|
_workspace/src/github.com/aws/aws-sdk-go/private/protocol/query
Package query provides serialisation of AWS query requests, and responses.
|
Package query provides serialisation of AWS query requests, and responses. |
|
_workspace/src/github.com/aws/aws-sdk-go/private/protocol/rest
Package rest provides RESTful serialization of AWS requests and responses.
|
Package rest provides RESTful serialization of AWS requests and responses. |
|
_workspace/src/github.com/aws/aws-sdk-go/private/protocol/xml/xmlutil
Package xmlutil provides XML serialisation of AWS requests and responses.
|
Package xmlutil provides XML serialisation of AWS requests and responses. |
|
_workspace/src/github.com/aws/aws-sdk-go/private/signer/v4
Package v4 implements signing for AWS V4 signer
|
Package v4 implements signing for AWS V4 signer |
|
_workspace/src/github.com/aws/aws-sdk-go/service/cloudwatch
Package cloudwatch provides a client for Amazon CloudWatch.
|
Package cloudwatch provides a client for Amazon CloudWatch. |
|
_workspace/src/github.com/aws/aws-sdk-go/service/cloudwatch/cloudwatchiface
Package cloudwatchiface provides an interface for the Amazon CloudWatch.
|
Package cloudwatchiface provides an interface for the Amazon CloudWatch. |
|
_workspace/src/github.com/aws/aws-sdk-go/service/ec2
Package ec2 provides a client for Amazon Elastic Compute Cloud.
|
Package ec2 provides a client for Amazon Elastic Compute Cloud. |
|
_workspace/src/github.com/aws/aws-sdk-go/service/ec2/ec2iface
Package ec2iface provides an interface for the Amazon Elastic Compute Cloud.
|
Package ec2iface provides an interface for the Amazon Elastic Compute Cloud. |
|
_workspace/src/github.com/bradfitz/gomemcache/memcache
Package memcache provides a client for the memcached cache server.
|
Package memcache provides a client for the memcached cache server. |
|
_workspace/src/github.com/codegangsta/cli
Package cli provides a minimal framework for creating and organizing command line Go applications.
|
Package cli provides a minimal framework for creating and organizing command line Go applications. |
|
_workspace/src/github.com/davecgh/go-spew/spew
Package spew implements a deep pretty printer for Go data structures to aid in debugging.
|
Package spew implements a deep pretty printer for Go data structures to aid in debugging. |
|
_workspace/src/github.com/fatih/color
Package color is an ANSI color package to output colorized or SGR defined output to the standard output.
|
Package color is an ANSI color package to output colorized or SGR defined output to the standard output. |
|
_workspace/src/github.com/go-ini/ini
Package ini provides INI file read and write functionality in Go.
|
Package ini provides INI file read and write functionality in Go. |
|
_workspace/src/github.com/go-ldap/ldap
Package ldap provides basic LDAP v3 functionality.
|
Package ldap provides basic LDAP v3 functionality. |
|
_workspace/src/github.com/go-macaron/binding
Package binding is a middleware that provides request data binding and validation for Macaron.
|
Package binding is a middleware that provides request data binding and validation for Macaron. |
|
_workspace/src/github.com/go-macaron/inject
Package inject provides utilities for mapping and injecting dependencies in various ways.
|
Package inject provides utilities for mapping and injecting dependencies in various ways. |
|
_workspace/src/github.com/go-macaron/session
Package session a middleware that provides the session management of Macaron.
|
Package session a middleware that provides the session management of Macaron. |
|
_workspace/src/github.com/go-sql-driver/mysql
Package mysql provides a MySQL driver for Go's database/sql package The driver should be used via the database/sql package: import "database/sql" import _ "github.com/go-sql-driver/mysql" db, err := sql.Open("mysql", "user:password@/dbname") See https://github.com/go-sql-driver/mysql#usage for details
|
Package mysql provides a MySQL driver for Go's database/sql package The driver should be used via the database/sql package: import "database/sql" import _ "github.com/go-sql-driver/mysql" db, err := sql.Open("mysql", "user:password@/dbname") See https://github.com/go-sql-driver/mysql#usage for details |
|
_workspace/src/github.com/go-xorm/xorm
Package xorm is a simple and powerful ORM for Go.
|
Package xorm is a simple and powerful ORM for Go. |
|
_workspace/src/github.com/gorilla/websocket
Package websocket implements the WebSocket protocol defined in RFC 6455.
|
Package websocket implements the WebSocket protocol defined in RFC 6455. |
|
_workspace/src/github.com/gosimple/slug
Package slug generate slug from unicode string, URL-friendly slugify with multiple languages support.
|
Package slug generate slug from unicode string, URL-friendly slugify with multiple languages support. |
|
_workspace/src/github.com/jtolds/gls
Package gls implements goroutine-local storage.
|
Package gls implements goroutine-local storage. |
|
_workspace/src/github.com/klauspost/compress/flate
Package flate implements the DEFLATE compressed data format, described in RFC 1951.
|
Package flate implements the DEFLATE compressed data format, described in RFC 1951. |
|
_workspace/src/github.com/klauspost/compress/gzip
Package gzip implements reading and writing of gzip format compressed files, as specified in RFC 1952.
|
Package gzip implements reading and writing of gzip format compressed files, as specified in RFC 1952. |
|
_workspace/src/github.com/klauspost/cpuid
Package cpuid provides information about the CPU running the current program.
|
Package cpuid provides information about the CPU running the current program. |
|
_workspace/src/github.com/klauspost/crc32
Package crc32 implements the 32-bit cyclic redundancy check, or CRC-32, checksum.
|
Package crc32 implements the 32-bit cyclic redundancy check, or CRC-32, checksum. |
|
_workspace/src/github.com/kr/pretty
Package pretty provides pretty-printing for Go values.
|
Package pretty provides pretty-printing for Go values. |
|
_workspace/src/github.com/kr/text
Package text provides rudimentary functions for manipulating text in paragraphs.
|
Package text provides rudimentary functions for manipulating text in paragraphs. |
|
_workspace/src/github.com/kr/text/colwriter
Package colwriter provides a write filter that formats input lines in multiple columns.
|
Package colwriter provides a write filter that formats input lines in multiple columns. |
|
_workspace/src/github.com/kr/text/mc
Command mc prints in multiple columns.
|
Command mc prints in multiple columns. |
|
_workspace/src/github.com/lib/pq
Package pq is a pure Go Postgres driver for the database/sql package.
|
Package pq is a pure Go Postgres driver for the database/sql package. |
|
_workspace/src/github.com/lib/pq/listen_example
Below you will find a self-contained Go program which uses the LISTEN / NOTIFY mechanism to avoid polling the database while waiting for more work to arrive.
|
Below you will find a self-contained Go program which uses the LISTEN / NOTIFY mechanism to avoid polling the database while waiting for more work to arrive. |
|
_workspace/src/github.com/lib/pq/oid
Package oid contains OID constants as defined by the Postgres server.
|
Package oid contains OID constants as defined by the Postgres server. |
|
_workspace/src/github.com/mattn/go-isatty
Package isatty implements interface to isatty
|
Package isatty implements interface to isatty |
|
_workspace/src/github.com/mattn/go-sqlite3
Package sqlite3 provides interface to SQLite3 databases.
|
Package sqlite3 provides interface to SQLite3 databases. |
|
_workspace/src/github.com/rainycape/unidecode
Package unidecode implements a unicode transliterator which replaces non-ASCII characters with their ASCII approximations.
|
Package unidecode implements a unicode transliterator which replaces non-ASCII characters with their ASCII approximations. |
|
_workspace/src/github.com/smartystreets/goconvey/convey
Package convey contains all of the public-facing entry points to this project.
|
Package convey contains all of the public-facing entry points to this project. |
|
_workspace/src/github.com/smartystreets/goconvey/convey/assertions
Package assertions contains the implementations for all assertions which are referenced in the convey package for use with the So(...) method.
|
Package assertions contains the implementations for all assertions which are referenced in the convey package for use with the So(...) method. |
|
_workspace/src/github.com/smartystreets/goconvey/convey/assertions/oglematchers
Package oglematchers provides a set of matchers useful in a testing or mocking framework.
|
Package oglematchers provides a set of matchers useful in a testing or mocking framework. |
|
_workspace/src/github.com/smartystreets/goconvey/convey/assertions/oglemock/createmock
createmock is used to generate source code for mock versions of interfaces from installed packages.
|
createmock is used to generate source code for mock versions of interfaces from installed packages. |
|
_workspace/src/github.com/smartystreets/goconvey/convey/assertions/oglemock/generate
Package generate implements code generation for mock classes.
|
Package generate implements code generation for mock classes. |
|
_workspace/src/github.com/smartystreets/goconvey/convey/assertions/oglemock/generate/test_cases/complicated_pkg
Package complicated_pkg contains an interface with lots of interesting cases, for use in integration testing.
|
Package complicated_pkg contains an interface with lots of interesting cases, for use in integration testing. |
|
_workspace/src/github.com/smartystreets/goconvey/convey/assertions/oglemock/generate/test_cases/renamed_pkg
A package that calls itself something different than its package path would have you believe.
|
A package that calls itself something different than its package path would have you believe. |
|
_workspace/src/github.com/smartystreets/goconvey/convey/assertions/ogletest
Package ogletest provides a framework for writing expressive unit tests.
|
Package ogletest provides a framework for writing expressive unit tests. |
|
_workspace/src/github.com/smartystreets/goconvey/convey/gotest
Package gotest contains internal functionality.
|
Package gotest contains internal functionality. |
|
_workspace/src/github.com/smartystreets/goconvey/convey/reporting
Package reporting contains internal functionality related to console reporting and output.
|
Package reporting contains internal functionality related to console reporting and output. |
|
_workspace/src/github.com/streadway/amqp
AMQP 0.9.1 client with RabbitMQ extensions Understand the AMQP 0.9.1 messaging model by reviewing these links first.
|
AMQP 0.9.1 client with RabbitMQ extensions Understand the AMQP 0.9.1 messaging model by reviewing these links first. |
|
_workspace/src/golang.org/x/net/context
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.
|
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes. |
|
_workspace/src/golang.org/x/oauth2
Package oauth2 provides support for making OAuth2 authorized and authenticated HTTP requests.
|
Package oauth2 provides support for making OAuth2 authorized and authenticated HTTP requests. |
|
_workspace/src/golang.org/x/oauth2/facebook
Package facebook provides constants for using OAuth2 to access Facebook.
|
Package facebook provides constants for using OAuth2 to access Facebook. |
|
_workspace/src/golang.org/x/oauth2/github
Package github provides constants for using OAuth2 to access Github.
|
Package github provides constants for using OAuth2 to access Github. |
|
_workspace/src/golang.org/x/oauth2/google
Package google provides support for making OAuth2 authorized and authenticated HTTP requests to Google APIs.
|
Package google provides support for making OAuth2 authorized and authenticated HTTP requests to Google APIs. |
|
_workspace/src/golang.org/x/oauth2/internal
Package internal contains support packages for oauth2 package.
|
Package internal contains support packages for oauth2 package. |
|
_workspace/src/golang.org/x/oauth2/jws
Package jws provides encoding and decoding utilities for signed JWS messages.
|
Package jws provides encoding and decoding utilities for signed JWS messages. |
|
_workspace/src/golang.org/x/oauth2/jwt
Package jwt implements the OAuth 2.0 JSON Web Token flow, commonly known as "two-legged OAuth 2.0".
|
Package jwt implements the OAuth 2.0 JSON Web Token flow, commonly known as "two-legged OAuth 2.0". |
|
_workspace/src/golang.org/x/oauth2/linkedin
Package linkedin provides constants for using OAuth2 to access LinkedIn.
|
Package linkedin provides constants for using OAuth2 to access LinkedIn. |
|
_workspace/src/golang.org/x/oauth2/odnoklassniki
Package odnoklassniki provides constants for using OAuth2 to access Odnoklassniki.
|
Package odnoklassniki provides constants for using OAuth2 to access Odnoklassniki. |
|
_workspace/src/golang.org/x/oauth2/paypal
Package paypal provides constants for using OAuth2 to access PayPal.
|
Package paypal provides constants for using OAuth2 to access PayPal. |
|
_workspace/src/golang.org/x/oauth2/vk
Package vk provides constants for using OAuth2 to access VK.com.
|
Package vk provides constants for using OAuth2 to access VK.com. |
|
_workspace/src/golang.org/x/sys/unix
Package unix contains an interface to the low-level operating system primitives.
|
Package unix contains an interface to the low-level operating system primitives. |
|
_workspace/src/gopkg.in/bufio.v1
Package bufio implements buffered I/O. It wraps an io.Reader or io.Writer object, creating another object (Reader or Writer) that also implements the interface but provides buffering and some help for textual I/O.
|
Package bufio implements buffered I/O. It wraps an io.Reader or io.Writer object, creating another object (Reader or Writer) that also implements the interface but provides buffering and some help for textual I/O. |
|
_workspace/src/gopkg.in/ini.v1
Package ini provides INI file read and write functionality in Go.
|
Package ini provides INI file read and write functionality in Go. |
|
_workspace/src/gopkg.in/macaron.v1
Package macaron is a high productive and modular web framework in Go.
|
Package macaron is a high productive and modular web framework in Go. |
|
_workspace/src/gopkg.in/redis.v2
Package redis implements a Redis client.
|
Package redis implements a Redis client. |
|
pkg
|
|
Click to show internal directories.
Click to hide internal directories.