Settings
Table of contents
- General settings
- Authentication settings
- Retention settings
- Grafana settings
- Jira settings
- Dynatrace settings
- Public settings
- Alert settings
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 Api User
Client facing url of Perfana, defaults to value of adminEmail
"perfanaApiUser": "perfana-api-user"
perfana Api Password
Client facing url of Perfana, defaults to value of adminPassword
"perfanaApiPassword": "secret"
perfana Check Url
Url used by Perfana to connect to perfana-check service, default value http://localhost:9191
"perfanaCheckUrl": "http://perfana-check:9191"
auto Compare TestRuns
If set to true, Perfana will automatically compare test runs if any Service Level Indicators have been configured with compare thresholds Default value is false
"autoCompareTestRuns": true
auto Set Baseline TestRun
If set to true and autoCompareTestRuns: true Perfana will set the first test run with a specific System under test, Test environment and Workload combination as fixed baseline test run. Default value is false
"autoSetBaselineTestRun": true
helmet frameSrc
Perfana uses iframes to display the Grafana, Jaeger and Pyroscope UI’s. To allow iframing these locations the client facing url patterns of the these UI’s should be added here, e.g. if the client facing url would be https://grafana.myhost.com, https://jaeger.myhost.com and https://pyrocsope.myhost.com:
"helmet": {
"frameSrc": [
"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
jaeger Limit
Maximum number of traces to show in Jaeger UI, default value 500
pyroscope Url
Client facing url of Pyrocope
"public": {
"forbidClientAccountCreation": true,
"perfanaUrl": "https://perfana.myhost.com",
"jaegerUrl": "https://jaeger.myhost.com",
"jaegerLimit": 500,
"pyroscopeUrl": "https://pyroscope.myhost.com",
"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"
}
],