From d47ae7beccc2fdecfea13e941786227cb4e17a35 Mon Sep 17 00:00:00 2001
From: Dominik Rosiek <drosiek@sumologic.com>
Date: Wed, 8 May 2024 11:23:00 +0200
Subject: [PATCH] chore: README

Signed-off-by: Dominik Rosiek <drosiek@sumologic.com>
---
 exporter/sumologicexporter/README.md | 43 +++++++---------------------
 1 file changed, 11 insertions(+), 32 deletions(-)

diff --git a/exporter/sumologicexporter/README.md b/exporter/sumologicexporter/README.md
index c678df2c3213..39267e26e61e 100644
--- a/exporter/sumologicexporter/README.md
+++ b/exporter/sumologicexporter/README.md
@@ -18,7 +18,7 @@
 
 For some time we have been developing the [new Sumo Logic exporter](https://github.com/SumoLogic/sumologic-otel-collector/tree/main/pkg/exporter/sumologicexporter#sumo-logic-exporter) and now we are in the process of moving it into this repository.
 
-The following options are deprecated for logs and already do not work for metrics:
+The following options are no longer supported:
 
 - `metric_format: {carbon2, graphite}`
 - `metadata_attributes: [<regex>]`
@@ -30,7 +30,7 @@ The following options are deprecated for logs and already do not work for metric
 After the new exporter will be moved to this repository:
 
 - `carbon2` and `graphite` are no longer supported and `prometheus` or `otlp` format should be used
-- all resource level attributes are going to be treated (are treated for metrics) as `metadata_attributes`. You can use [Group by Attributes processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/groupbyattrsprocessor) to move attributes from record level to resource level. For example:
+- all resource level attributes are treated as `metadata_attributes` so this option is no longer supported. You can use [Group by Attributes processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/groupbyattrsprocessor) to move attributes from record level to resource level. For example:
 
   ```yaml
   # before switch to new collector
@@ -45,7 +45,7 @@ After the new exporter will be moved to this repository:
         - my_attribute
   ```
 
-- Source templates (`source_category`, `source_name` and `source_host`) are going to be removed from the exporter and sources may be set using `_sourceCategory`, `sourceName` or `_sourceHost` resource attributes.  This feature has been already disabled for metrics. We recommend to use [Transform Processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor/). For example:
+- Source templates (`source_category`, `source_name` and `source_host`) are no longer supported. We recommend to use [Transform Processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor/). For example:
 
   ```yaml
   # before switch to new collector
@@ -88,12 +88,12 @@ exporters:
     # List of regexes for attributes which should be send as metadata
     # default = []
     #
-    # This option is deprecated:
+    # This option is unsupported:
     # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter#migration-to-new-architecture
     metadata_attributes: [<regex>]
 
-    # format to use when sending logs to Sumo Logic, default = json,
-    log_format: {json, text}
+    # format to use when sending logs to Sumo Logic, default = otlp,
+    log_format: {otlp, json, text}
 
     # format to use when sending metrics to Sumo Logic, default = otlp,
     # NOTE: only `otlp` is supported when used with sumologicextension
@@ -112,7 +112,7 @@ exporters:
     # Please regfer to Source temmplates for formatting explanation:
     # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter#source-templates
     #
-    # This option is deprecated:
+    # This option is unsupported:
     # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter#migration-to-new-architecture
     graphite_template: <template>
 
@@ -121,7 +121,7 @@ exporters:
     # Please regfer to Source temmplates for formatting explanation:
     # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter#source-templates
     #
-    # This option is deprecated:
+    # This option is unsupported:
     # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter#migration-to-new-architecture
     source_category: <template>
 
@@ -130,7 +130,7 @@ exporters:
     # Please regfer to Source temmplates for formatting explanation:
     # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter#source-templates
     #
-    # This option is deprecated:
+    # This option is unsupported:
     # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter#migration-to-new-architecture
     source_name: <template>
 
@@ -139,7 +139,7 @@ exporters:
     # Please regfer to Source temmplates for formatting explanation:
     # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter#source-templates
     #
-    # This option is deprecated:
+    # This option is unsupported:
     # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter#migration-to-new-architecture
     source_host: <template>
 
@@ -183,25 +183,4 @@ exporters:
 
 ## Source Templates
 
-You can specify a template with an attribute for `source_category`, `source_name`, `source_host` or `graphite_template` using `%{attr_name}`.
-
-For example, when there is an attribute `my_attr`: `my_value`, `metrics/%{my_attr}` would be expanded to `metrics/my_value`.
-
-For `graphite_template`, in addition to above, `%{_metric_}` is going to be replaced with metric name.
-
-## Example Configuration
-
-```yaml
-exporters:
-  sumologic:
-    endpoint: http://localhost:3000
-    compress_encoding: "gzip"
-    max_request_body_size: "1_048_576"  # 1MB
-    log_format: "text"
-    metric_format: "prometheus"
-    source_category: "custom category"
-    source_name: "custom name"
-    source_host: "custom host"
-    metadata_attributes:
-      - k8s.*
-```
+Source Templates are no longer supported. Please follow [Migration to new architecture](#migration-to-new-architecture)