Skip to content

Commit 568ada3

Browse files
authored
improve receiver_creator and k8sobserver docs (#35323)
**Description:** This PR includes the `k8s.ingress` type in the list of supported types and adds a note in `k8sobserver`'s back to the `receiver_creator`'s docs so as users can find more extensive configuration examples. **Link to tracking Issue:** <Issue number if applicable> Fixes #34740 --------- Signed-off-by: ChrsMark <[email protected]>
1 parent 4d38785 commit 568ada3

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

extension/observer/k8sobserver/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,6 @@ All fields are optional.
7373
| 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.|
7474
| observe_services | bool | `false` | Whether to report observer k8s.service endpoints.|
7575
| observe_ingresses | bool | `false` | Whether to report observer k8s.ingress endpoints.|
76+
77+
More complete configuration examples on how to use this observer along with the `receiver_creator`,
78+
can be found at the [Receiver Creator](../../../receiver/receivercreator/README.md)'s documentation.

receiver/receivercreator/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,12 @@ None
133133
| k8s.node.name | \`name\` |
134134
| k8s.node.uid | \`uid\` |
135135

136+
`type == "k8s.ingress"`
137+
138+
| Resource Attribute | Default |
139+
|--------------------|-------------------|
140+
| k8s.namespace.name | \`namespace\` |
141+
136142
See `redis/2` in [examples](#examples).
137143

138144

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

150156
## Rule Expressions
151157

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

0 commit comments

Comments
 (0)