Documentation survey

API Keys

API keys are used for sending telemetry data to SUSE Observability. It now offers two types of API keys:

  • Receiver API Key: This key is typically generated during the initial installation of your SUSE Observability instance, and it never expires

  • Ingestion API Key: You can create Ingestion API Keys using the SUSE Observability CLI (STS). These keys offer expiration dates, requiring periodic rotation for continued functionality.

The receiver API key can be found in your values.yaml as the receiverApiKey, but you can also find it in the installation instructions of the stackpacks. For example if you installed the Kubernetes stackpack:

  1. Open SUSE Observability

  2. Navigate to StackPacks and select the Kubernetes StackPack

  3. Open one of the installed instances

  4. Scroll down to the first set of installation instructions. It shows the API key as STACKSTATE_RECEIVER_API_KEY in text and as 'stackstate.apiKey' in the command.

Ingestion API Keys (Deprecated)

Ingestion API Keys were used by external tools to ingest data (such as metrics, events and traces) to the SUSE Observability cluster. These tools include the STS Agent or/and OTel Collector. Currently, the recommended authentication mechanism is through Service Tokens.