Skip to content

Add a few minor notes to the new receiver instructions. #165

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

Merged
merged 1 commit into from
Aug 24, 2021
Merged

Add a few minor notes to the new receiver instructions. #165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions dev-docs/new-receivers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ Ops Agent config design. Below are some conventions we are trying to follow:
configuration does not contain 3rd party application specific configuration. Users need to define the pipeline(s) to
enable log and metrics ingestion for an application (We will provide copy-pastable instructions).
- A `type` field is required for each receiver.
- The convention for receiver / processor ID is to use underscore as word delimiter. e.g. `apache_access`.
- Logging specific
- The receiver, without customization, scrapes this application's logs from common log file paths and parses them with
the common regex.
Expand All @@ -76,6 +77,7 @@ Ops Agent config design. Below are some conventions we are trying to follow:
default log file paths / formats might change based on the value of the `version` parameter.
- Metrics specific
- The application specific metrics receiver(s) scrape the metrics data points from the application, and convert them into Google Cloud Monitoring data model formats.
- A `collection_interval` parameter is highly recommended for each metrics receiver.
- If there are required user settings (e.g. username, password) for the Ops Agent to talk to the application, the metrics receiver(s) should have corresponding parameter.
- If we need to support more than one versions of the application, and the metrics setup vary significantly across versions, the metrics receivers should have a corresponding `version` parameter. And the way this receiver works might change based on the value of the `version` parameter.

Expand Down