Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[receiver/hostmetrics] Add documentation for mute_*_error configuration fields #32494

Merged
merged 8 commits into from
Jul 22, 2024
Merged

[receiver/hostmetrics] Add documentation for mute_*_error configuration fields #32494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ec6d6dc
update comments
bsponge Apr 17, 2024
34cfa98
add mute_*_error config fields documentation
bsponge Apr 17, 2024
c5573d6
add changelog file
bsponge Apr 17, 2024
62af24f
run make fmt
bsponge Apr 17, 2024
b9c2f85
move descriptions to root hostmetricsreceiver readme
bsponge Apr 17, 2024
4b64b71
remove an empty line
bsponge Apr 17, 2024
f760a8e
remove changelog file
bsponge Apr 17, 2024
6ef98e9
Update receiver/hostmetricsreceiver/README.md
bsponge Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions receiver/hostmetricsreceiver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,14 @@ process:
scrape_process_delay: <time>
```

The following settings are optional:

- `mute_process_name_error` (default: false): mute the error encountered when trying to read a process name the collector does not have permission to read
- `mute_process_io_error` (default: false): mute the error encountered when trying to read IO metrics of a process the collector does not have permission to read
- `mute_process_cgroup_error` (default: false): mute the error encountered when trying to read the cgroup of a process the collector does not have permission to read
- `mute_process_exe_error` (default: false): mute the error encountered when trying to read the executable path of a process the collector does not have permission to read (Linux only)
- `mute_process_user_error` (default: false): mute the error encountered when trying to read a uid which doesn't exist on the system, eg. is owned by a user that only exists in a container.

## Advanced Configuration

### Filtering
Expand Down
12 changes: 6 additions & 6 deletions receiver/hostmetricsreceiver/internal/scraper/processscraper/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,21 @@ type Config struct {
Include MatchConfig `mapstructure:"include"`
Exclude MatchConfig `mapstructure:"exclude"`

// MuteProcessNameError is a flag that will mute the error encountered when trying to read a process the
// collector does not have permission for.
// MuteProcessNameError is a flag that will mute the error encountered when trying to read a process name the
// collector does not have permission to read.
// See https://github.com/open-telemetry/opentelemetry-collector/issues/3004 for more information.
MuteProcessNameError bool `mapstructure:"mute_process_name_error,omitempty"`

// MuteProcessIOError is a flag that will mute the error encountered when trying to read IO metrics of a process
// the collector does not have permission for.
// the collector does not have permission to read.
MuteProcessIOError bool `mapstructure:"mute_process_io_error,omitempty"`

// MuteProcessCgroupError is a flag that will mute the error encountered when trying to read the cgroup of a process
// the collector does not have permission for.
// the collector does not have permission to read.
MuteProcessCgroupError bool `mapstructure:"mute_process_cgroup_error,omitempty"`

// ResilientProcessScraping is a flag that will let the collector continue reading a process even when
// the collector does not have permission to read it's executable path (Linux)
// MuteProcessExeError is a flag that will mute the error encountered when trying to read the executable path of a process
// the collector does not have permission to read (Linux)
MuteProcessExeError bool `mapstructure:"mute_process_exe_error,omitempty"`

// MuteProcessUserError is a flag that will mute the error encountered when trying to read uid which
Expand Down
Loading