Additional Settings¶

Global Config¶

The globalConfig Helm value defines global variables re-used across Robusta.

Robusta also expects several parameters to always be defined in globalConfig:

cluster_name

Unique for each cluster in your organization. Cluster Name be human-readable and need not be secret

account_id

Keep secret! The Account ID uniquely identifies your cluster with Robusta cloud (if enabled). Should never be the same for different organizations. Together, cluster_name and account_id uniquely identify every cluster running Robusta in the world

signing_key

Keep secret! The Signing Key is used to authenticate requests to run playbooks from outside the cluster (if enabled).

These values are generated automatically when setting up Robusta with the CLI. If you install Robusta on additional clusters, make sure you change cluster_name accordingly. The other values should remain the same.

If you need to generate the secret values yourself, use cryptographically secure strings with at least 128 bits of randomness.

Relabel Prometheus Alerts¶

In order to enrich alerts, Robusta maps Prometheus alerts to related Kubernetes resources.

The following labels determine which Kubernetes resource relates to an alert:

If your alerts have different labels, you can change the mapping with the alertRelabel helm value.

A relabeling has 3 attributes:

• source: The label's name on your alerts (which differs from the expected value in the above table)

• target: The standard label name that Robusta expects (a value from the table above)

• operation: Either add (default) or replace. If add, your custom mapping will be recognized in addition to Robusta's default mapping.

For example:

alertRelabel:
  - source: "pod_name"
    target: "pod"
    operation: "add"
  - source: "deployment_name"
    target: "deployment"
    operation: "replace"
  - source: "job_name"
    target: "job"

Mapping Custom Alert Severity¶

To help you prioritize alerts from different sources, Robusta maps alert severity to four standard levels:

• HIGH - requires your immediate attention - may indicate a service outage

• LOW - minor problems and areas for improvement (e.g. performance) - to be reviewed periodically on a weekly or bi-weekly cadence

• INFO - you probably want to be aware of these, but do not necessarily need to take action

• DEBUG - debug only - can be ignored unless you're actively debugging an issue

You are free to interpret these levels differently, but the above is a good starting point for most companies.

Prometheus alerts are normalized to the above levels as follows:

Prometheus alerts with a severity not in the above list are mapped to Robusta's INFO level.

You can map your own Prometheus severities, using the custom_severity_map Helm value. For example:

globalConfig:
  custom_severity_map:
    # maps a p1 value on your own alerts to Robusta's HIGH value
    p1: high
    # maps a p2 value on your own alerts to Robusta's LOW value
    p2: low

The mapped values must be one of: high, low, info, and debug.

Two-way Interactivity¶

Two-way interactivity allows the Robusta UI and the Slack sink to connect to the Robusta running in your cluster.

The Robusta UI uses interactivity to display dynamic data, such as Prometheus graphs. Slack uses it to support custom remediation buttons.

To enable interactivity, set the following in your generated_values.yaml file:

disableCloudRouting: false

Censoring Logs¶

Pod logs gathered by Robusta can be censored using regexes. For example, a payment processing pod might have credit card numbers in its log. These can be sanitized in-cluster.

This feature applies to the following Robusta actions:

• logs_enricher

• report_crash_loop

To censor logs, define a python regex for expressions you wish to filter.

For example:

- logs_enricher:
    regex_replacement_style: SAME_LENGTH_ASTERISKS # You can also use NAMED
    regex_replacer_patterns:
      - name: MySecretPort
          regex: "my secret port \\d+"
      - name: UUID
          regex: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"

Given the following input:

# Input (actual pod log):
2022-07-28 08:24:45.283 INFO     user's uuid: '193836d9-9cce-4df9-a454-c2edcf2e80e5'
2022-07-28 08:35:00.762 INFO     Successfully loaded some critical module
2022-07-28 08:35:01.090 INFO     using my secret port 114, ip: ['172.18.0.3']

The censored output will be:

# Output for SAME_LENGTH_ASTERISKS (How it will appear in Slack, for example):

2022-07-28 08:24:45.283 INFO     user's uuid: '************************************'
2022-07-28 08:35:00.762 INFO     Successfully loaded some critical module
2022-07-28 08:35:01.090 INFO     using ******************, ip: ['172.18.0.3']

# Output for NAMED (How it will appear in Slack, for example):

2022-07-28 08:24:45.283 INFO     user's uuid: '[UUID]'
2022-07-28 08:35:00.762 INFO     Successfully loaded some critical module
2022-07-28 08:35:01.090 INFO     using [MySecretPort], ip: ['172.18.0.3']

It is best to define this in a Global Config, so it will be applied everywhere.

globalConfig: # Note: no need to specify logs_enricher or report_crash_loop by name here.
  regex_replacement_style: SAME_LENGTH_ASTERISKS
  regex_replacer_patterns:
    - name: MySecretPort
      regex: "my secret port \\d+"
    - name: UUID
      regex: "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"

Place these values inside Robusta's Helm values and perform a Helm Upgrade.

Memory allocation on big clusters¶

On bigger clusters, increase Robusta's memory requests and limits

Add this to Robusta's Helm values:

runner:
  resources:
    requests:
      memory: 2048Mi
    limits:
      memory: 2048Mi