k8sattributes processor documentation PR

processor/k8sattributesprocessor/doc.go

@@ -94,7 +94,28 @@
 //
 // Config
 //
-// TODO: example config.
+//      k8sattributes:
+//      k8sattributes/2:
+//        auth_type: "serviceAccount"
+//        passthrough: false
+//        filter:
+//          node_from_env_var: KUBE_NODE_NAME
+//
+//        extract:
+//          metadata:
+//            - k8s.pod.name
+//            - k8s.pod.uid
+//            - k8s.deployment.name
+//            - k8s.cluster.name
+//            - k8s.namespace.name
+//            - k8s.node.name
+//            - k8s.pod.start_time
+//
+//        pod_association:
+//         - from: resource_attribute
+//           name: k8s.pod.ip
+//         - from: resource_attribute
+//           name: k8s.pod.uid
 //
 // Deployment scenarios
 //
@@ -117,15 +138,19 @@
 // 1. Use the downward API to inject the node name as an environment variable.
 // Add the following snippet under the pod env section of the OpenTelemetry container.
 //
-//    env:
-//    - name: KUBE_NODE_NAME
-//      valueFrom:
-//  	  fieldRef:
-//  	    apiVersion: v1
-//  	    fieldPath: spec.nodeName
+//
+//    spec:
+//      containers:
+//      - env:
+//        - name: KUBE_NODE_NAME
+//          valueFrom:
+//            fieldRef:
+//              apiVersion: v1
+//              fieldPath: spec.nodeName
 //
 // This will inject a new environment variable to the OpenTelemetry container with the value as the
 // name of the node the pod was scheduled to run on.
+
 //
 // 2. Set "filter.node_from_env_var" to the name of the environment variable holding the node name.
 //