Skip to content

grafana job from prometheus/18.6.0

Github source: 61f6c4d or master branch

Properties

env

http_proxy

HTTP proxy to use

https_proxy

HTTPS proxy to use

no_proxy

List of comma-separated hosts that should skip connecting to the proxy

grafana

alerting

enabled

Enable alerting engine & UI featuresn

execute_alerts

Makes it possible to turn off alert rule execution

analytics

check_for_updates

Set to false to disable all checks to https://grafana.net

google_analytics_ua_id

Google Analytics universal tracking code, only enabled if you specify an id here

google_tag_manager_id

Google Tag Manager ID

reporting_enabled

Change this option to false to disable reporting.

app_mode

possible values : production, development

auth

anonymous
enabled

enable anonymous access

org_name

specify organization name that should be used for unauthenticated users

org_role

specify role for unauthenticated users

basic
enabled

Auth basic enabled

disable_login_form

Set to true to disable (hide) the login form, useful if you use OAuth, defaults to false

generic_oauth
allow_sign_up

Generic OAuth allow sign up

allowed_domains

Generic OAuth allowed organizations

api_url

Generic OAuth api url

auth_url

Generic OAuth url

client_id

Generic OAuth client id

client_secret

Generic OAuth client secret

enabled

Generic OAuth enabled

name

Generic OAuth name

scopes

Generic OAuth scopes

team_ids

Generic OAuth team ids

tls_client_ca

Generic OAuth TLS Client CA

tls_client_cert

Generic OAuth TLS Client cert

tls_client_key

Generic OAuth TLS Client key

token_url

Generic OAuth token url

github
allow_sign_up

Github auth allow sign up

allowed_organizations

Github auth allowed organizations

api_url

Github auth api url

auth_url

Github auth url

client_id

Github auth client id

client_secret

Github auth client secret

enabled

Github auth enabled

scopes

Github auth scopes

team_ids

Github auth tema ids

token_url

Github auth token url

google
allow_sign_up

Google auth allow sign up

allowed_domains

Google auth allowed organizations

api_url

Google auth api url

auth_url

Google auth url

client_id

Google auth client id

client_secret

Google auth client secret

enabled

Google auth enabled

scopes

Google auth scopes

token_url

Google auth token url

grafananet
allow_sign_up

Grafana.net auth allow sign up

allowed_organizations

Grafana.net auth allowed organizations

client_id

Grafana.net auth client id

client_secret

Grafana.net auth client secret

enabled

Grafana.net auth enabled

scopes

Grafana.net auth scopes

ldap
allow_sign_up

Auth LDAP allow sign up

config

LDAP configuration (toml)

enabled

Auth LDAP enable

proxy
auto_sign_up

Auth proxy auto sign up

enabled

Auth proxy enabled

header_name

Auth proxy header name

header_property

Auth proxy header property

dashboards

custom_homepage_json

Override the default homepage with a custom dashboard in JSON format (http://docs.grafana.org/reference/dashboard/)

json
enabled

Enable Dashboard JSON files

database

host

(MySQL & PostgreSQL only) Database Host. If not set, a ‘database’ link is expected

max_idle_conn

(MySQL & PostgreSQL only) Database max idle connections

max_open_conn

(MySQL & PostgreSQL only) Database max open connections

name

(MySQL & PostgreSQL only) Database Name

password

(MySQL & PostgreSQL only) Database Password

port

(MySQL & PostgreSQL only) Database Port

server_cert_name

(MySQL only) The common name field of the certificate used by the mysql server. Not necessary if ssl_mode is set to ‘skip-verify’

ssl_mode

(MySQL & PostgreSQL only) For Postgres, use either ‘disable’, ‘require’ or ‘verify-full’. For MySQL, use either ‘true’, ‘false’, or ‘skip-verify’

tls_client_ca

(MySQL & PostgreSQL only) Database TLS client CA

tls_client_cert

(MySQL & PostgreSQL only) Database TLS client cert

tls_client_key

(MySQL & PostgreSQL only) Database TLS client key

type

Database Type, either ‘mysql’, ‘postgres’ or ‘sqlite3’

Default
sqlite3
user

(MySQL & PostgreSQL only) Database User

dataproxy

logging_enabled

Enable data proxy logging

emails

welcome_email_on_sign_up

Welcome email on sign up

event_publisher

enabled

Event publisher enabled

exchange

Exchange topic

rabbitmq_url

RabbitMQ URL

external_image_storage

provider

Used for uploading images to public servers so they can be included in slack/email messages (s3, webdav)

s3
access_key

S3 Access Key

bucket_url

S3 Bucket URL

secret_key

S3 Secret Key

webdav
password

Webdav Password

url

Webdav URL

username

Webdav Username

grafana_net

url

Url used to to import dashboards directly from Grafana.net

influxdb

database

InfluxDB database to configure as Grafana data source

datasource_input_name

Name of the InfluxDB datasource input name

Default
DS_INFLUXDB
datasource_name

Name of the InfluxDB datasource

Default
influxdb
password

InfluxDB password to configure as Grafana data source

url

InfluxDB URL to configure as Grafana data source

username

InfluxDB user to configure as Grafana data source

log

console
format

log line format, valid options are text, console and json

level

log level

file
daily_rotate

Segment log daily

format

log line format, valid options are text, console and json

level

log level

log_rotate

This enables automated log rotate(switch of following options)

max_days

Expired days of log file(delete after max days)

max_lines

Max line number of single file

max_size_shift

Max size shift of single file

filters

Optional settings to set different levels for specific loggers

level

log level. Either ‘trace’, ‘debug’, ‘info’, ‘warn’, ‘error’, ‘critical’

mode

Either ‘console’, ‘file’, ‘syslog’. Use space to separate multiple modes

syslog
address

Syslog address

facility

Syslog facility. user, daemon and local0 through local7 are valid.

format

log line format, valid options are text, console and json

level

log level

network

Syslog network type. This can be udp, tcp, or unix

tag

Syslog tag

metrics

enabled

Enable internal metrics

graphite
address

Graphite address

prefix

Graphite prefix

interval_seconds

Publish interval

prometheus

dashboard_files

Array of dashboard json file locations or glob patterns

datasource_input_name

Name of the Prometehus datasource input name

Default
DS_PROMETHEUS
datasource_name

Name of the Prometheus datasource

Default
prometheus
use_external_url

If true and prometheus provides one, use the external url to reach prometheus

Default
true

quota

enabled

Enable Usage Quotas

global_api_key

global limit of api_keys

global_dashboard

global limit of dashboards

global_org

global limit of orgs

global_session

global limit on number of logged in users

global_user

Global limit of users

org_api_key

limit number of api_keys per Org

org_dashboard

limit number of dashboards per Org

org_data_source

limit number of data_sources per Org

org_user

limit number of users per Org

user_org

limit number of orgs a user can create

security

admin_password

default admin password

admin_user

default admin user

Default
admin
cookie_remember_name

Auto-login cookie remember name

cookie_username

Auto-login cookie username

data_source_proxy_whitelist

data source proxy whitelist (ip_or_domain:port separated by spaces)

disable_gravatar

disable gravatar profile images

login_remember_days

Auto-login remember days

secret_key

used for signing

server

domain

The public facing domain name used to access grafana from a browser

enable_gzip

Enable gzip

enforce_domain

Redirect to correct domain if host header does not match domain

http_port

The http port to bind to

Default
3000
protocol

Protocol (http or https)

root_url

The full public facing url

router_logging

Log web requests

ssl_cert

SSL certificate (PEM encoded)

ssl_key

SSL private key (PEM encoded)

static_root_path

The relative working path

session

cookie_name

Session cookie name

cookie_secure

If you use session in https only

gc_interval_time

GC Interval time

provider

Either ‘memory’, ‘file’, ‘redis’, ‘mysql’, ‘postgres’

Default
file
provider_config

(MySQL, PostgreSQL & Redis only) Provider config options. If not set, a ‘database’ link is expected

provider_name

(MySQL, PostgreSQL & Redis only) Provider database name (used only when no provider_config is provided)

provider_password

(MySQL, PostgreSQL & Redis only) Provider database password (used only when no provider_config is provided)

provider_port

(MySQL, PostgreSQL & Redis only) Provider database port (used only when no provider_config is provided)

provider_user

(MySQL & PostgreSQL only) Provider database user (used only when no provider_config is provided)

session_life_time

Session life time

smtp

enabled

SMTP enabled

from_address

SMTP from address

from_name

SMTP from name

host

SMTP host

password

SMTP password

skip_verify

SMTP skip SSL verification

ssl_cert

SMTP SSL certificate

ssl_key

SMTP SSL private key

user

SMTP user

snapshots

external_enabled

Extenal snaphot enabled

external_snapshot_name

External snapshot name

external_snapshot_url

External snapshot URL

remove_expired

Remove expired snapshots

ttl_days

Snapshots TTL days

users

allow_org_create

Allow non admin users to create organizations

allow_sign_up

disable user signup / registration

auto_assign_org

Set to true to automatically assign new users to the default organization (id 1)

auto_assign_org_role

Default role new users will be automatically assigned (if disabled above is set to true)

default_theme

Default UI theme (‘dark’ or ‘light’)

login_hint

Background text for the user field on the login page

seeded_global_users

Array of Grafana users to be seeded

Default
[]
Example
- email: [email protected]
  login: user
  name: user name
  password: userpassword
verify_email_enabled

Require email validation before sign up completes

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/grafana/ directory (learn more).

  • bin/grafana-admin-password (from bin/grafana-admin-password)
  • bin/grafana-homepage (from bin/grafana-homepage)
  • bin/grafana-users (from bin/grafana-users)
  • bin/grafana_ctl (from bin/grafana_ctl)
  • bin/influxdb-datasource (from bin/influxdb-datasource)
  • bin/post-start (from bin/post-start)
  • bin/pre-start (from bin/pre-start)
  • bin/prometheus-dashboards (from bin/prometheus-dashboards)
  • bin/prometheus-datasource (from bin/prometheus-datasource)
  • config/database_tls_client_ca.pem (from config/database_tls_client_ca.pem)
  • config/database_tls_client_cert.pem (from config/database_tls_client_cert.pem)
  • config/database_tls_client_key.pem (from config/database_tls_client_key.pem)
  • config/generic_oauth_tls_client_ca.pem (from config/generic_oauth_tls_client_ca.pem)
  • config/generic_oauth_tls_client_cert.pem (from config/generic_oauth_tls_client_cert.pem)
  • config/generic_oauth_tls_client_key.pem (from config/generic_oauth_tls_client_key.pem)
  • config/grafana.ini (from config/grafana.ini)
  • config/ldap.toml (from config/ldap.toml)
  • config/smtp_cert.pem (from config/smtp_cert.pem)
  • config/smtp_key.pem (from config/smtp_key.pem)
  • config/ssl_cert.pem (from config/ssl_cert.pem)
  • config/ssl_key.pem (from config/ssl_key.pem)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.