update README

jj22ee · Nov 7, 2024 · 0e7bbb3 · 0e7bbb3
1 parent 751437b
commit 0e7bbb3
Showing 1 changed file with 7 additions and 52 deletions.
diff --git a/processor/awsapplicationsignalsprocessor/README.md b/processor/awsapplicationsignalsprocessor/README.md
@@ -1,15 +1,15 @@
-# AWS AppSignals Processor for Amazon Cloudwatch Agent
+# AWS Application Signals Processor
 
-The AWS AppSignals processor is used to reduce the cardinality of telemetry metrics and traces before exporting them to CloudWatch Logs via [EMF](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awsemfexporter) and [X-Ray](github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awsxrayexporter) respectively.
-It reduces the cardinality of metrics/traces via 3 types of actions, `keep`, `drop` and `replace`, which are configured by users. CloudWatch Agent(CWA) customers will configure these rules with their CWA configurations.
+The AWS AppSignals processor is used to reduce the cardinality of telemetry metrics and traces before exporting them to CloudWatch Logs via [EMF](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awsemfexporter) and [X-Ray](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awsxrayexporter) respectively.
+It reduces the cardinality of metrics/traces via 3 types of actions, `keep`, `drop` and `replace`, which are configured by users. Users can configure these rules through the configurations.
 
 Note: Traces support only `replace` actions and are implicitly pulled from the logs section of the CWA configuration
 
 | Status                   |                           |
 | ------------------------ |---------------------------|
 | Stability                | [beta]                    |
 | Supported pipeline types | metrics, traces           |
-| Distributions            | [amazon-cloudwatch-agent] |
+| Distributions            | [contrib]                 |
 
 ## Exporter Configuration
 
@@ -51,7 +51,9 @@ A replacements section defines a matching against the dimensions of incoming met
 
 ```yaml
 awsapplicationsignals:
-    resolvers: ["eks"]
+    resolvers:
+      - platform: eks
+        name: test
     rules:
       - selectors:
           - dimension: Operation
@@ -80,51 +82,4 @@ awsapplicationsignals:
             value: "This is a test string"
         action: replace
         rule_name: "replace01"
-```
-
-## Amazon CloudWatch Agent Configuration Example
-
-```json
-{
-          "agent": {
-            "region": "us-west-2",
-            "debug": true
-          },
-          "traces": {
-            "traces_collected": {
-              "app_signals": {}
-            }
-          },
-          "logs": {
-            "metrics_collected": {
-              "app_signals": {
-                "rules": [
-                  {
-                    "selectors": [
-                      {
-                        "dimension": "Service",
-                        "match": "pet-clinic-frontend"
-                      },
-                      {
-                        "dimension": "RemoteService",
-                        "match": "customers-service"
-                      }
-                  ],
-                    "action": "keep",
-                    "rule_name": "keep01"
-                },
-                {
-                  "selectors": [
-                    {
-                      "dimension": "Operation",
-                      "match": "GET *"
-                    }
-                ],
-                  "action": "drop",
-                  "rule_name": "drop01"
-                }
-              }
-            }
-          }
-        }
 ```