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

Jump to bottom

improve receiver_creator and k8sobserver docs #35323

Merged
merged 6 commits into from
Sep 26, 2024
Merged

improve receiver_creator and k8sobserver docs #35323

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c189fb1
improve receiver_creator and k8sobserver docs
ChrsMark Sep 20, 2024
a36514f
add default resource attribute config
ChrsMark Sep 20, 2024
fe9bfcd
Merge branch 'main' into receivercreatordocs
ChrsMark Sep 23, 2024
37b4907
Merge branch 'main' into receivercreatordocs
ChrsMark Sep 24, 2024
2136be6
Merge branch 'main' into receivercreatordocs
ChrsMark Sep 25, 2024
08ac5fd
Merge branch 'main' into receivercreatordocs
ChrsMark Sep 26, 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
3 changes: 3 additions & 0 deletions extension/observer/k8sobserver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,6 @@ All fields are optional.
| observe_nodes | bool | `false` | Whether to report observer k8s.node endpoints. If `true` and `node` is specified it will only discover node endpoints whose `metadata.name` matches the provided node name. If `true` and `node` isn't specified, it will discover all available node endpoints. Please note that Collector connectivity to nodes is dependent on your cluster configuration and isn't guaranteed.|
| observe_services | bool | `false` | Whether to report observer k8s.service endpoints.|
| observe_ingresses | bool | `false` | Whether to report observer k8s.ingress endpoints.|

More complete configuration examples on how to use this observer along with the `receiver_creator`,
can be found at the [Receiver Creator](../../../receiver/receivercreator/README.md)'s documentation.
8 changes: 7 additions & 1 deletion receiver/receivercreator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,12 @@ None
| k8s.node.name | \`name\` |
| k8s.node.uid | \`uid\` |

`type == "k8s.ingress"`

| Resource Attribute | Default |
|--------------------|-------------------|
| k8s.namespace.name | \`namespace\` |

See `redis/2` in [examples](#examples).


Expand All @@ -149,7 +155,7 @@ Similar to the per-endpoint type `resource_attributes` described above but for i

## Rule Expressions

Each rule must start with `type == ("pod"|"port"|"hostport"|"container"|"k8s.service"|"k8s.node") &&` such that the rule matches
Each rule must start with `type == ("pod"|"port"|"hostport"|"container"|"k8s.service"|"k8s.node"|"k8s.ingress") &&` such that the rule matches
only one endpoint type. Depending on the type of endpoint the rule is
targeting it will have different variables available.

Expand Down