SigNoz Toolkit
The SigNoz Toolkit is a workflow node. Its tools include List Services, Get Service Overview, Search Traces, Get Trace Detail, plus 6 more listed below. Create a connection before you use any of these tools. Type @ in a field when the value should come from an earlier step.
Authentication
Create a SigNoz connection before you use any of these tools.
Create an API key in SigNoz
- Sign in to your SigNoz instance.
- Open Settings, then API Keys.
- Click Create New Key, select Role: Admin, and copy the key.
Connect the key in EKB
- On the first SigNoz node, open Connection.
- Click + New.
- Enter a Connection Name.
- Paste the API Key, or click the key button next to that field and select a vault key that already exists. If the key has not been created yet, add it first on the Datastore Vault tab.
- Enter the SigNoz Instance URL, including
https://. - Select the new connection in Select saved connection.
Enter token manually saves the same credentials on that node instead of a saved connection.
Tools
List Services
List monitored services with latency, error rate, and throughput.
| Field | Required | Description |
|---|---|---|
| Start Time | No | Start time in epoch milliseconds. Defaults to 1 hour ago. Type @ to select a variable. |
| End Time | No | End time in epoch milliseconds. Defaults to now. Type @ to select a variable. |
Get Service Overview
Read rate, error, and duration metrics for one service.
| Field | Required | Description |
|---|---|---|
| Service Name | Yes | The service name to get an overview for. Type @ to select a variable. |
| Start Time | No | Start time in epoch milliseconds. Defaults to 1 hour ago. Type @ to select a variable. |
| End Time | No | End time in epoch milliseconds. Defaults to now. Type @ to select a variable. |
Search Traces
Search traces by service, operation, status, and duration.
| Field | Required | Description |
|---|---|---|
| Service Name | No | Filter traces by service name. Type @ to select a variable. |
| Operation Name | No | Filter traces by operation (span) name. Type @ to select a variable. |
| Status Code | No | Filter by status code: ERROR, OK, or UNSET. Type @ to select a variable. |
| Min Duration | No | Minimum trace duration (e.g. '100ms', '1s'). Type @ to select a variable. |
| Max Duration | No | Maximum trace duration (e.g. '5s', '1m'). Type @ to select a variable. |
| Limit | No | Max traces to return (default 20, max 100). Type @ to select a variable. |
| Start Time | No | Start time in epoch milliseconds. Defaults to 1 hour ago. Type @ to select a variable. |
| End Time | No | End time in epoch milliseconds. Defaults to now. Type @ to select a variable. |
Get Trace Detail
Read the spans for one trace ID.
| Field | Required | Description |
|---|---|---|
| Trace ID | Yes | The trace ID to look up (hex string). Type @ to select a variable. |
Query Logs
Query logs by text, service, severity, and time range.
| Field | Required | Description |
|---|---|---|
| Query String | No | Query text. Type @ to select a variable. |
| Limit | No | Max log lines to return (default 20, max 200). Type @ to select a variable. |
| Lookback Hours | No | Type @ to select a variable. |
| Start Time | No | Optional explicit start time in epoch milliseconds. Type @ to select a variable. |
| End Time | No | Optional explicit end time in epoch milliseconds. Type @ to select a variable. |
| Order By | No | Sort field: 'timestamp' or 'severity_text'. Type @ to select a variable. |
| Order | No | Sort direction: 'ASC' or 'DESC'. Type @ to select a variable. |
Get Log Attribute Values
List distinct values for a log or resource attribute.
| Field | Required | Description |
|---|---|---|
| Attribute Key | Yes | The log or resource attribute to get distinct values for (e.g. 'service.name', 'severity_text'). The legacy alias 'service_name' is also supported. Type @ to select a variable. |
| Start Time | No | Start time in epoch milliseconds. Defaults to 1 hour ago. Type @ to select a variable. |
| End Time | No | End time in epoch milliseconds. Defaults to now. Type @ to select a variable. |
Query Metrics
Query a metric with an aggregation over a time range.
| Field | Required | Description |
|---|---|---|
| Metric Name | Yes | Metric name to query. Type @ to select a variable. |
| Aggregation | No | Aggregation type: avg, sum, min, max, count, rate, p50, p90, p95, p99. Type @ to select a variable. |
| Service Name | No | Filter by service name. Type @ to select a variable. |
| Start Time | No | Start time in epoch milliseconds. Defaults to 1 hour ago. Type @ to select a variable. |
| End Time | No | End time in epoch milliseconds. Defaults to now. Type @ to select a variable. |
| Step Seconds | No | Step interval in seconds for the query (default 60). Type @ to select a variable. |
List Available Metrics
List metric names in the SigNoz instance.
| Field | Required | Description |
|---|---|---|
| Start Time | No | Start time in epoch milliseconds. Defaults to 1 hour ago. Type @ to select a variable. |
| End Time | No | End time in epoch milliseconds. Defaults to now. Type @ to select a variable. |
List Alert Rules
List alert rules with their state and severity.
Get Alert Rule
Read one alert rule by ID.
| Field | Required | Description |
|---|---|---|
| Rule ID | Yes | The alert rule ID to look up. Type @ to select a variable. |
Related
See all integrations on the toolkits overview.