Ingestion Keys

Overview

Ingestion Keys are secure tokens used to authenticate your telemetry Ingestion requests. These keys are unique to your account and should be kept confidential.

Pre-requisite

• SigNoz Cloud account

Add an Ingestion Key

To add a SigNoz Ingestion key:

1. Navigate to Settings in the sidebar, then select the Ingestion Settings tab.
2. Click the New Ingestion Key button.
3. Enter a name for your key.
4. (Optional) Set an expiration date for the key.
5. (Optional) Add tags to categorize or organize your key.
6. Click Create new Ingestion key.

Limits and Restrictions:

• Only administrators can manage Ingestion keys.
• There is a maximum limit of 50 Ingestion keys per account.
• Key names must be unique within your account.

Modify Ingestion Keys

To modify an existing SigNoz Ingestion key, navigate to Settings > Ingestion Settings and click the edit icon next to the relevant key. Please note that only the expiry date and tags can be modified.

Remove Ingestion Keys

To remove a SigNoz Ingestion key, go to Settings > Ingestion Settings. Users with the appropriate permissions can click the Trash icon next to the key they wish to remove. A confirmation prompt will appear before the key is deleted. Please be aware that this action is irreversible and will immediately revoke the Ingestion key.

Add Limits to a Key

SigNoz offers the flexibility to set limits on your Ingestion keys. To add a limit to an existing key:

1. Click on the target key to open its dropdown menu.
2. In the dropdown, select the signal to which you want to apply the limit.
3. Click on + Limits.
4. Specify an appropriate limit value.
5. Click on Save.

Modify a Limit

To modify an existing limit, navigate to the Ingestion key and click the edit option corresponding to the limit in question. It's important to note that modifying a limit does not reset the accumulated values. For example, if the initial limit was 20GB/day and you've used 15GB before increasing the limit to 25GB/day, the usage count will continue from 15GB.

Remove a Limit

To remove a limit, navigate to the Ingestion key and click the delete option next to the relevant limit. Deleting a limit will reset all accumulated values. For instance, if the limit was set to 20GB/day and you've used 15GB before deleting the limit, the counter will be reset to 0. Any new limit created thereafter will start from 0.

Filter Logs and Traces by Ingestion Key

You can filter logs and traces by ingestion key to view only the telemetry data ingested through a specific key. This is useful for:

• Identifying which data is coming from a specific integration or source
• Troubleshooting data ingestion from particular environments or services
• Analyzing usage patterns by ingestion key

View Logs by Ingestion Key

To filter logs by a specific ingestion key:

1. Navigate to the Logs tab in your SigNoz dashboard
2. In the filter section, add a new filter for signoz.workspace.key.id
3. Set the operator to IN or =
4. Enter your specific ingestion key ID as the value
5. Apply the filter to view logs ingested using that key

View Traces by Ingestion Key

To filter traces by a specific ingestion key:

1. Navigate to the Traces tab in your SigNoz dashboard
2. In the filter section, add a new filter for signoz.workspace.key.id
3. Set the operator to IN or =
4. Enter your specific ingestion key ID as the value
5. Apply the filter to view traces ingested using that key

Finding Your Ingestion Key ID

To find the ID of a specific ingestion key:

1. Go to Settings > Ingestion Settings
2. The key ID is displayed in the ingestion keys list
3. You can copy the key ID for use in filters