Repository navigation
docs(integrations): list Utilization & Health and the trace heatmap for Splunk Enterprise - #936
reckless-sherixx wants to merge 1 commit into
Conversation
…or Splunk Enterprise The Splunk Enterprise page did not say that the cluster Utilization & Health card, the Trend charts and a workload's Utilization Trends tab read Splunk metrics, or which metric names they look for. It called the trace heatmap "the span waterfall", so a search for "heatmap" found nothing. And it said Splunk alerts do not become events without pointing to the Splunk Webhook integration, which does that. - Metrics: describe Utilization & Health and add the metric-name table - Traces: name the heatmap as the trace's Service & Operation tab - Verify: add a Utilization & Health step - Notes: link the Splunk Webhook page and say its tile is grayed out Signed-off-by: reckless-sherixx <141176362+reckless-sherixx@users.noreply.github.com>
There was a problem hiding this comment.
Code Review
This pull request updates the Splunk Enterprise integration documentation to detail how utilization and health metrics are read, including a table of the specific Splunk metric names checked. It also documents support for the trace heatmap, adds a verification step for utilization metrics, and clarifies how Splunk alerts can be integrated via webhooks. The review feedback suggests minor grammatical and terminology improvements to enhance clarity and maintain parallel structure, specifically by rephrasing the metrics provider configuration description and changing 'requested' to 'request' in the workload utilization description.
|
|
||
| What uses Splunk metrics: | ||
|
|
||
| - **Utilization & Health.** When Splunk Enterprise is the account's metrics provider, which **Default Metrics Provider** sets, the cluster and workload utilization views read the metric index: |
There was a problem hiding this comment.
The phrase "which Default Metrics Provider sets" is grammatically awkward. It is clearer to refer to it as a setting.
| - **Utilization & Health.** When Splunk Enterprise is the account's metrics provider, which **Default Metrics Provider** sets, the cluster and workload utilization views read the metric index: | |
| - **Utilization & Health.** When Splunk Enterprise is the account's metrics provider (configured via the **Default Metrics Provider** setting), the cluster and workload utilization views read the metric index: |
References
- Use US English spelling consistently throughout the documentation (e.g., 'utilization' instead of 'utilisation').
|
|
||
| - **Utilization & Health.** When Splunk Enterprise is the account's metrics provider, which **Default Metrics Provider** sets, the cluster and workload utilization views read the metric index: | ||
| - On the cluster's **Summary** tab, the **Utilization & Health** card shows CPU and memory **Total**, **Usage**, **Request**, **Limit**, **P50 Usage**, **P90 Usage**, and **Max Usage**. **Trend** charts usage, total, request, and limit over the selected time range. | ||
| - On a workload's **Utilization Trends** tab, the CPU and memory charts show its usage, requested, and limit. |
There was a problem hiding this comment.
Use "request" instead of "requested" to maintain parallel noun structure with "usage" and "limit", and to remain consistent with the terminology used in the previous bullet point.
| - On a workload's **Utilization Trends** tab, the CPU and memory charts show its usage, requested, and limit. | |
| - On a workload's **Utilization Trends** tab, the CPU and memory charts show its usage, request, and limit. |
References
- Use US English spelling consistently throughout the documentation (e.g., 'utilization' instead of 'utilisation').
Summary
The Splunk Enterprise page left out three things readers look for:
Verify the Integration gains a Utilization & Health step.
Each statement was checked against a running NudgeBee with Splunk Enterprise as the account's metrics and traces provider:
mstatsquery run directly in Splunk (3 nodes, 12 cores, 48 GiB).The metric-name table is copied from the lookup order in the server code.
Type of change
Checklist
npm run buildlocally and the site builds without errorsnpm run lintlocally and lint passesgit commit -s)