Enterprise Grafana Configurations

You can configure the Grafana for the enterprise deployment. All the required configuration parameters are stored in CONFIG_FOLDER_REDTAIL/rt_grafana_vars.json

Each of the parameters is explained in more detail in the following table:

Grafana Configuration Options

Parameter

Description

certs_conf_path

The directory where the certificates required for communicating with other nodes is stored

 

Mandatory: Yes

Suggested Value: /usr/local/etc/rt_certs

data_path

The base directory for storing TIBCO OI Hawk RedTail services data. All the services store the data in the path categorized by service name.

 

Mandatory: Yes

Suggested Value: DATA_FOLDER

conf_path

The base directory for storing TIBCO OI Hawk RedTail services configuration.

 

Mandatory:

Suggested Value: CONFIG_FOLDER_REDTAIL

zookeeper_node_url

ZooKeeper URL

 

Mandatory: Yes

Suggested Value: localhost

grafana_node_url

Grafana URL

 

Mandatory: Yes

Suggested Value: localhost

postgres_node_url

Postgres URL

 

Mandatory:

Suggested Value: localhost

zookeeper.connectString

Host and port of ZooKeeper

 

Mandatory: Yes

Suggested Value: zookeeper:9600

ZK_CLIENT_KEY_FILE

Path to the ZooKeeper client private key

 

Mandatory: Yes

Suggested Value: {certs_conf_path}/key

ZK_CLIENT_KEY_PASSWORD

Password of the ZooKeeper client key

 

Mandatory: Yes

Suggested Value: <password>

ZK_CLIENT_CACERT_FILE

Path to the CA certificate file used for generating the key

 

Mandatory: Yes

Suggested Value: {certs_conf_path}/cacert

ZK_CLIENT_CERT_FILE

Path to the ZooKeeper client certificate

 

Mandatory: Yes

Suggested Value: {certs_conf_path}/certificate

GF_USERS_ALLOW_SIGN_UP

When set to false, this parameter prohibits users from being able to sign up or create user accounts. The admin user can still create users from the Grafana Admin Pages.

Default:false.

 

Mandatory: Yes

Suggested Value: false

GF_USERS_AUTO_ASSIGN_ORG

When set to true: Automatically adds new users to the main organization (ID 1).

When set to false: A new organization is created for the new user automatically.

Default:true

 

Mandatory: Yes

Suggested Value: true

GF_USERS_AUTO_ASSIGN_ORG_ROLE

The role new users are assigned for the main organization (if GF_USERS_AUTO_ASSIGN_ORG is set to true). For TIBCO OI Hawk RedTail, this value must be Editor.

 

Default Value: Viewer

Mandatory: Yes

Suggested Value: Editor

GF_USERS_DEFAULT_THEME

Set the default UI theme: dark or light. Default is dark. For TIBCO OI Hawk RedTail, the suggested value is light.

 

Mandatory: Yes

Suggested Value: light

GF_AUTH_PROXY_ENABLED

Set to true, for Grafana to let a HTTP reverse proxy handle authentication. For TIBCO OI Hawk RedTail, this value must be true.

 

Mandatory: Yes

Suggested Value: true

GF_AUTH_PROXY_HEADER_NAME

HTTP Header name that contains the user name

 

Mandatory: Yes

Suggested Value: X-WEBAUTH-USER

GF_AUTH_PROXY_HEADER_PROPERTY

HTTP Header property, defaults to username

 

Mandatory: Yes

Suggested Value: username

GF_AUTH_PROXY_AUTO_SIGN_UP

Set to true to enable auto sign up of users who do not exist in the Grafana database. Default is true.

 

Mandatory: Yes

Suggested Value: true

GF_SERVER_DOMAIN

This setting is only used in as a part of the root_url setting

 

Mandatory: Yes

Suggested Value: {grafana_node_url}

GF_SERVER_HTTP_PORT

The port to bind to

 

Default Value: 3000

Mandatory: Yes

Suggested Value: 3000

GF_SERVER_ROOT_URL

This is the full URL used to access Grafana from a web browser

 

Mandatory: Yes

Suggested Value: %(protocol)s://%(domain)s:%(http_port)s/redtail/grafana

GF_AUTH_BASIC_ENABLED

Basic authentication is enabled by default and works with built-in Grafana. Do not disable basic auth for TIBCO OI Hawk RedTail.

 

Mandatory: Yes

Suggested Value: true

GF_SECURITY_ALLOW_EMBEDDING

Default:false.

When false, the X-Frame-Options deny HTTP header is set in the Grafana HTTP responses. Thus, browsers do not allow rendering Grafana in <frame>, <iframe>, <embed>, or <object>. For TIBCO OI Hawk RedTail, set this value to true.

 

Mandatory: Yes

Suggested Value: true

GF_PATHS_PLUGINS

Directory where Grafana automatically scans and looks for plug-ins. Manually or automatically install any plug-ins here.

 

Mandatory: Yes

Suggested Value: {conf_path}/grafana/plugins

GF_DATABASE_TYPE

Type of database where Grafana stores all the data

 

Mandatory: Yes

Suggested Value: postgres

GF_DATABASE_HOST

Host and IP port of the database

 

Mandatory: Yes

Suggested Value: {postgres_node_url}:5432

GF_DATABASE_NAME

Name of the database

 

Mandatory: Yes

Suggested Value: grafana

GF_DATABASE_USER

Database user name

 

Mandatory: Yes

Suggested Value: postgres

GF_DATABASE_PASSWORD

Database user password

 

Mandatory: Yes

Suggested Value: mypassword

GF_DATABASE_SSL_MODE

Skips verification of the certificate chain and hostname when making the connection

 

Mandatory: Yes

Suggested Value: require

GF_DATABASE_CA_CERT_PATH

Database CA certificate

 

Mandatory: Yes

Suggested Value: {certs_conf_path}/gf_dbcacert

GF_LOG_LEVEL

Specifies the level of diagnostic information stored in the logs. The logging levels are as follows:

ERROR - Indicates that error level trace messages should be enabled.
WARNING - Indicates that warning level trace messages should be enabled.
INFO - Indicates that information level trace messages should be enabled.
DEBUG - Indicates that debug level trace messages should be enabled.
TRACE - Indicates that trace level messages should be enabled.

 

Mandatory: No

Suggested Value: DEBUG