Link Search Menu Expand Document

Settings

Table of contents

  1. General settings
    1. Organisations
    2. admin Email
    3. admin Password
    4. perfana Url
    5. perfana Check Url
    6. influxDb Host
    7. allowed Frame Src
  2. Authentication settings
    1. authentication Services
    2. login Expiration In Days
  3. Retention settings
    1. prometheus Retention
    2. graphite Retention
    3. influxDb Retention
    4. elasticSearch Retention
    5. snapshot Expires
  4. Grafana settings
    1. grafana Instances
  5. Jira settings
    1. jira Instances
  6. Dynatrace settings
    1. dynatrace Url
    2. dynatrace Api Token
  7. Public settings
    1. forbid Client Account Creation
    2. override Login Button Text
    3. google Sign In
    4. perfana Url
    5. jaeger Url
    6. jaeger Limit
  8. Alert settings
    1. custom Alert Tags
    2. omit Alert Tags

Perfana was built using the Meteor framework. Perfana are passed to the application in JSON format via the METEOR_SETTINGS environment variable

The following configuration can be set:

General settings

Organisations

It is possible to add multiple organisations to Perfana to organise your teams by.

 "organisations": [
    {
      "name": "Org1",
      "description": "Organisation 1"
    },
    {
      "name": "Org2",
      "description": "Organisation 2"
    }
  ],

If omitted, a default organisation named Perfana will be added.

admin Email

If, at startup of Perfana, no users are found with the admin role, a user with the admin role is created with this email address. Default value: “admin@perfana.io”

  "adminEmail": "admin@mycompany.com"

admin Password

If, at startup of Perfana, no users are found with the admin role, a user with the admin role is created with this password. Default value: “perfana”

  "adminPassword": "secret"

perfana Url

Client facing url of Perfana, default value http://localhost:4000

  "perfanaUrl": "https://perfana.myhost.com"

perfana Check Url

Url used by Perfana to connect to perfana-check service, default value http://localhost:9191

  "perfanaCheckUrl": "http://perfana-check:9191"

influxDb Host

Hostname used by Perfana to connect to InfluxDB, default value localhost

  "influxDbHost": "influxDB"

allowed Frame Src

Perfana uses iframes to display the Grafana and Jaeger UI. To allow iframing these locations the client facing url patterns of the Grafana and Jaeger UI should be added here, e.g. if the client facing url would be https://grafana.myhost.com and https://jaeger.myhost.com:

  "allowedFrameSrc": [
    "https://*.myhost.com"
  ],

Authentication settings

authentication Services

If an external service is used to authenticate Perfana users, add settings here.

 "authenticationServices": {
    "keycloak": {
      "realm": "perfana",
      "auth-server-url": "https://keycloak:8443/auth",
      "loginStyle": "popup",
      "ssl-required": "external",
      "resource": "perfana-fe",
      "public-client": true,
      "use-resource-role-mappings": true,
      "bearer-only": true,
      "realm-public-key": "<keycloak public key>"
    }
  },

login Expiration In Days

Defines after how many days the user has to sign in again, default value is 1 day. It is possible to use decimal values, e.g.

  "loginExpirationInDays": 0.5

Retention settings

Perfana decides based on these datasource retention settings to show “live” Grafana dashboards, connecting to the datasources to fetch data or, if the data is no longer available, show snapshots of the dashboards instead. If no retention has been configured for a datasource, Perfana will assume retention is 0 and will always show snapshots.

prometheus Retention

Metrics retention in seconds. Default value is 2592000 (30 days).

  "prometheusRetention": "43200"  // 12 hours

graphite Retention

Metrics retention in seconds. Default value is 2592000 (30 days).

  "graphiteRetention": "86400"  // 24 hours

influxDb Retention

Metrics retention in seconds. Default value is 2592000 (30 days).

  "influxDbRetention": "604800"  // 1 week

elasticSearch Retention

Metrics retention in seconds. Default value is 2592000 (30 days).

  "elasticSearchRetention": "2592000"  // 30 days

snapshot Expires

This setting is used to specify how long snapshots will be stored in Grafana in seconds. Default value is 7776000 (90 days).

  "snapshotExpires": "7776000"  // 90 days

If snapshotExpires is set to 0, snapshots will not expire.


If no expiry is set for snapshots, the Grafana database will continue to grow!


Grafana settings

Perfana requires at least one Grafana instance to be configured, refer to here for more details.

grafana Instances

"grafanaInstances": [
    {
      "label": "Demo",
      "clientUrl": "http://localhost:3000",
      "serverUrl": "http://grafana:3000",
      "orgId": "1",
      "apiKey": "[apiKey]",
      "username": "perfana",
      "password": "perfana",
      "snapshotInstance": true,
      "trendsInstance": true,
    }
  ],

Jira settings

To integrate with Jira, add oauth settings for one or more Jira instances. Refer to here for more details

jira Instances

    "jiraInstances": [ 	
        { 		
            "host": "jira.mycompany.com", 		
            "oauth": { 			
                "consumer_key": "perfana", 			
                "private_key": "-----BEGIN PRIVATE <key> -----END PRIVATE KEY-----\n", 			
                "token": "<token>", 			
                "token_secret": "<secret>" 		
            } 	
        }
    ],  

Dynatrace settings

To integrate with Dynatrace, add these properties, refer to here for more details

dynatrace Url

    "dynatraceUrl": "<Dynatrace host>"

dynatrace Api Token

    "dynatraceApiToken": "<Dynatrace token>",

Public settings

Settings that need to be exposed to the client are in the public section

forbid Client Account Creation

Set this value to true if you want to disable the option to register new users from the login screen. Defaults to false

override Login Button Text

If you are using Keycloak as authentication service, this property can be used to set the login button text.

google Sign In

If you are using Google as authentication service, setting this property to true will show a Google branded login button

perfana Url

Client facing url of Perfana, default value http://localhost:4000

jaeger Url

Client facing url of Jaeger, default value http://localhost:16686

jaeger Limit

Maximum number of traces to show in Jaeger UI, default value 500

"public": {
    "forbidClientAccountCreation": true,
    "perfanaUrl": "http://localhost:4000",
    "jaegerUrl": "https://jaeger.myhost.com",
    "jaegerLimit": 500,
    "overrideLoginButtonText": "My company Login",
    "googleSignIn": "true"
  },

Alert settings

custom Alert Tags

If alerts do not have system_under_test and test_environment labels to allow Perfana to map alerts to test runs, you can specify custom tags and (dynamic) values to be used for mapping.

 "customAlertTags": [
    {
        "key": "application",
        "value": "perfana-applications"
    },
    {
        "key": "namespace",
        "value": "perfana-test-environment"
    }
 ],

omit Alert Tags

By default, Perfana passes on all tags set on incoming alerts. If you want to omit specific tags, add them here.

"omitAlertTags": [
    {
        "alertSource": "alertmanager",
        "tag": "kubernetes_pod_name"
    },
    {
        "alertSource": "alertmanager",
        "tag": "node"
    }
 ],

Copyright © 2019-2021 Perfana Software BV