output: stackdriver: Add documentation for labels_key (fluent#339)

Signed-off-by: Jeff Luo <[email protected]>

Author: JeffLuoo

pipeline/outputs/stackdriver.md

@@ -16,8 +16,9 @@ Before to get started with the plugin configuration, make sure to obtain the pro
 | service\_account\_email | Account email associated to the service. Only available if **no credentials file** has been provided. | Value of environment variable _$SERVICE\_ACCOUNT\_EMAIL_ |
 | service\_account\_secret | Private key content associated with the service account. Only available if **no credentials file** has been provided. | Value of environment variable _$SERVICE\_ACCOUNT\_SECRET_ |
 | resource | Set resource type of data. Supported resource types: _k8s\_container_, _k8s\_node_, _k8s\_pod_, _global_ and _gce\_instance_. | global, gce\_instance |
-| k8s\_cluster\_name | The name of the cluster that the container \(node or pod based on the resource type\) is running in. If the resource type is one of the _k8s\_container_, _k8s\_node_ or _k8s\_pod_, then this field is required. |  |
-| k8s\_cluster\_location | The physical location of the cluster that contains \(node or pod based on the resource type\) the container. If the resource type is one of the _k8s\_container_, _k8s\_node_ or _k8s\_pod_, then this field is required. |  |
+| k8s\_cluster\_name | The name of the cluster that the container \(node or pod based on the resource type\) is running in. If the resource type is one of the _k8s\_container_, _k8s\_node_ or _k8s\_pod_, then this field is required. |
+| k8s\_cluster\_location | The physical location of the cluster that contains \(node or pod based on the resource type\) the container. If the resource type is one of the _k8s\_container_, _k8s\_node_ or _k8s\_pod_, then this field is required. |
+| labels\_key | The value of this field is used by the Stackdriver output plugin to find the related labels from jsonPayload and then extract the value of it to set the LogEntry Labels.| logging.googleapis.com/labels |
 
 ### Configuration File
 

pipeline/outputs/stackdriver_special_fields.md

@@ -6,6 +6,8 @@ Currently, we also support some special fields in fluent-bit:
 | JSON log field | [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) field | Logging agent function |
 | :--- | :--- | :--- |
 | logging.googleapis.com/operation | operation | The value of this field is also used by the Logs Viewer to group related log entries |
+| logging.googleapis.com/labels | labels | The value of this field should be a structured record |
+
 
 ## Operaiton
 Operation field contains additional information about a potentially long-running operation with which a log entry is associated.
@@ -127,3 +129,31 @@ the logEntry will be:
     ...
 }
 ```
+## Labels
+labels field contains specific labels in a structured entry that will be added to LogEntry labels.
+
+For example, when the jsonPayload contains the subfield `logging.googleapis.com/labels`:
+```text
+jsonPayload {
+    "logging.googleapis.com/labels": {
+        "A": "valA",
+        "B": "valB",
+        "C": "valC"
+    }
+    ...
+}
+```
+the stackdriver output plugin will extract labels from the subfield `logging.googleapis.com/labels` and move it up from jsonPayload to LogEntry Labels. LogEntry will be:
+```text
+{
+    "jsonPayload": {
+        ...
+    }
+    "labels": {
+        "A": "valA",
+        "B": "valB",
+        "C": "valC"
+    }
+    ...
+}
+```