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.

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

[processor/k8sattributes] Fix doc.go #9243

Merged
merged 1 commit into from
Apr 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 1 deletion processor/k8sattributesprocessor/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ type FieldFilterConfig struct {
// with logs, spans and metrics
type PodAssociationConfig struct {
// From represents the source of the association.
// Allowed values are "connection" and "labels".
// Allowed values are "connection" and "resource_attribute".
From string `mapstructure:"from"`

// Name represents extracted key name.
Expand Down
6 changes: 3 additions & 3 deletions processor/k8sattributesprocessor/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
// - k8s.node.name
// Not all the attributes are guaranteed to be added. For example `k8s.cluster.name` usually is not provided by k8s API,
// so likely it won't be set as an attribute.

//
// The following container level attributes require additional attributes to identify a particular container in a pod:
// 1. Container spec attributes - will be set only if container identifying attribute `k8s.container.name` is set
// as a resource attribute (similar to all other attributes, pod has to be identified as well):
Expand All @@ -62,7 +62,7 @@
// 2. Container status attributes - in addition to pod identifier and `k8s.container.name` attribute, these attributes
// require identifier of a particular container run set as `k8s.container.restart_count` in resource attributes:
// - container.id

//
//The k8sattributesprocessor can be used for automatic tagging of spans, metrics and logs with k8s labels and annotations from pods and namespaces.
//The config for associating the data passing through the processor (spans, metrics and logs) with specific Pod/Namespace annotations/labels is configured via "annotations" and "labels" keys.
//This config represents a list of annotations/labels that are extracted from pods/namespaces and added to spans, metrics and logs.
Expand All @@ -87,7 +87,7 @@
// key: label2
// regex: field=(?P<value>.+)
// from: pod

//
// RBAC
//
// TODO: mention the required RBAC rules.
Expand Down