Skip to content

Commit 960ae72

Browse files
shalper2dmathieu
authored andcommitted
Disable default search metrics (open-telemetry#39068)
#### Description Removing default metrics (i.e. setting all metrics to `enabled: false`). This is primarily to prevent unwanted ad-hoc searches from running on Splunk Enterprise deployments which could have unforeseen side effects. #### Documentation The `README.md` was updated to reflect these changes.
1 parent 27dd247 commit 960ae72

File tree

7 files changed

+214
-192
lines changed

7 files changed

+214
-192
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: 'breaking'
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: splunkenterprisereceiver
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: "disabled default metrics except for splunkHealth to ensure scrapes run on Splunk instance are opt-in"
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [39068]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: [user]

receiver/splunkenterprisereceiver/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ jobs.
2020

2121
## Configuration
2222

23+
**By default the Splunk Enterprise receiver is not configured to gather any metrics other than `splunk.health`**
24+
2325
The following settings are required, omitting them will either cause your receiver to fail to compile or result in 4/5xx return codes during scraping.
2426

2527
**NOTE:** These must be set for each Splunk instance type (indexer, search head, or cluster master) from which you wish to pull metrics. At present, only one of each type is accepted, per configured receiver instance. This means, for example, that if you have three different "indexer" type instances that you would like to pull metrics from you will need to configure three different `splunkenterprise` receivers for each indexer node you wish to monitor.

0 commit comments

Comments
 (0)