From 76a29ff8827c937fc318d2481c10a0e8d66d7d3f Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Fri, 2 Aug 2024 14:29:13 -0400 Subject: [PATCH] Renamed data prepper files to have dashes for consistency (#7790) * Renamed data prepper files to have dashes for consistency Signed-off-by: Fanit Kolchina * More files Signed-off-by: Fanit Kolchina --------- Signed-off-by: Fanit Kolchina --- _data-prepper/common-use-cases/log-enrichment.md | 2 +- _data-prepper/common-use-cases/trace-analytics.md | 6 +++--- .../extensions/{geoip_service.md => geoip-service.md} | 0 .../{convert_entry_type.md => convert-entry-type.md} | 0 .../processors/{delete_entries.md => delete-entries.md} | 0 _data-prepper/pipelines/configuration/processors/geoip.md | 2 +- .../pipelines/configuration/processors/mutate-event.md | 4 ++-- .../processors/{otel_metrics.md => otel-metrics.md} | 0 .../processors/{otel_traces.md => otel-traces.md} | 0 .../configuration/processors/{parse_ion.md => parse-ion.md} | 0 .../processors/{parse_json.md => parse-json.md} | 0 .../configuration/processors/{parse_xml.md => parse-xml.md} | 0 .../processors/{service_map.md => service-map.md} | 0 .../processors/{split_string.md => split-string.md} | 0 .../processors/{string_converter.md => string-converter.md} | 0 .../{substitute_string.md => substitute-string.md} | 0 .../processors/{trim_string.md => trim-string.md} | 0 .../processors/{write_json.md => write-json.md} | 0 _data-prepper/pipelines/configuration/sources/s3.md | 2 +- _ingest-pipelines/processors/convert.md | 2 +- _observing-your-data/trace/ta-dashboards.md | 2 +- 21 files changed, 10 insertions(+), 10 deletions(-) rename _data-prepper/managing-data-prepper/extensions/{geoip_service.md => geoip-service.md} (100%) rename _data-prepper/pipelines/configuration/processors/{convert_entry_type.md => convert-entry-type.md} (100%) rename _data-prepper/pipelines/configuration/processors/{delete_entries.md => delete-entries.md} (100%) rename _data-prepper/pipelines/configuration/processors/{otel_metrics.md => otel-metrics.md} (100%) rename _data-prepper/pipelines/configuration/processors/{otel_traces.md => otel-traces.md} (100%) rename _data-prepper/pipelines/configuration/processors/{parse_ion.md => parse-ion.md} (100%) rename _data-prepper/pipelines/configuration/processors/{parse_json.md => parse-json.md} (100%) rename _data-prepper/pipelines/configuration/processors/{parse_xml.md => parse-xml.md} (100%) rename _data-prepper/pipelines/configuration/processors/{service_map.md => service-map.md} (100%) rename _data-prepper/pipelines/configuration/processors/{split_string.md => split-string.md} (100%) rename _data-prepper/pipelines/configuration/processors/{string_converter.md => string-converter.md} (100%) rename _data-prepper/pipelines/configuration/processors/{substitute_string.md => substitute-string.md} (100%) rename _data-prepper/pipelines/configuration/processors/{trim_string.md => trim-string.md} (100%) rename _data-prepper/pipelines/configuration/processors/{write_json.md => write-json.md} (100%) diff --git a/_data-prepper/common-use-cases/log-enrichment.md b/_data-prepper/common-use-cases/log-enrichment.md index 0c878dd76e..0d8ce4ab7d 100644 --- a/_data-prepper/common-use-cases/log-enrichment.md +++ b/_data-prepper/common-use-cases/log-enrichment.md @@ -370,7 +370,7 @@ The `date` processor can generate timestamps for incoming events if you specify ### Deriving punctuation patterns -The [`substitute_string`]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/substitute_string/) processor (which is one of the mutate string processors) lets you derive a punctuation pattern from incoming events. In the following example pipeline, the processor will scan incoming Apache log events and derive punctuation patterns from them: +The [`substitute_string`]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/substitute-string/) processor (which is one of the mutate string processors) lets you derive a punctuation pattern from incoming events. In the following example pipeline, the processor will scan incoming Apache log events and derive punctuation patterns from them: ```yaml processor: diff --git a/_data-prepper/common-use-cases/trace-analytics.md b/_data-prepper/common-use-cases/trace-analytics.md index 3deca7b632..1a961077fe 100644 --- a/_data-prepper/common-use-cases/trace-analytics.md +++ b/_data-prepper/common-use-cases/trace-analytics.md @@ -32,7 +32,7 @@ To monitor trace analytics in Data Prepper, we provide three pipelines: `entry-p ### OpenTelemetry trace source -The [OpenTelemetry source]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/otel_traces/) accepts trace data from the OpenTelemetry Collector. The source follows the [OpenTelemetry Protocol](https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/protocol) and officially supports transport over gRPC and the use of industry-standard encryption (TLS/HTTPS). +The [OpenTelemetry source]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/otel-traces/) accepts trace data from the OpenTelemetry Collector. The source follows the [OpenTelemetry Protocol](https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/protocol) and officially supports transport over gRPC and the use of industry-standard encryption (TLS/HTTPS). ### Processor @@ -49,8 +49,8 @@ OpenSearch provides a generic sink that writes data to OpenSearch as the destina The sink provides specific configurations for the trace analytics feature. These configurations allow the sink to use indexes and index templates specific to trace analytics. The following OpenSearch indexes are specific to trace analytics: -* otel-v1-apm-span –- The *otel-v1-apm-span* index stores the output from the [otel_traces_raw]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/otel_traces/) processor. -* otel-v1-apm-service-map –- The *otel-v1-apm-service-map* index stores the output from the [service_map_stateful]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/service_map/) processor. +* otel-v1-apm-span –- The *otel-v1-apm-span* index stores the output from the [otel_traces_raw]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/otel-traces/) processor. +* otel-v1-apm-service-map –- The *otel-v1-apm-service-map* index stores the output from the [service_map_stateful]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/service-map/) processor. ## Trace tuning diff --git a/_data-prepper/managing-data-prepper/extensions/geoip_service.md b/_data-prepper/managing-data-prepper/extensions/geoip-service.md similarity index 100% rename from _data-prepper/managing-data-prepper/extensions/geoip_service.md rename to _data-prepper/managing-data-prepper/extensions/geoip-service.md diff --git a/_data-prepper/pipelines/configuration/processors/convert_entry_type.md b/_data-prepper/pipelines/configuration/processors/convert-entry-type.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/convert_entry_type.md rename to _data-prepper/pipelines/configuration/processors/convert-entry-type.md diff --git a/_data-prepper/pipelines/configuration/processors/delete_entries.md b/_data-prepper/pipelines/configuration/processors/delete-entries.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/delete_entries.md rename to _data-prepper/pipelines/configuration/processors/delete-entries.md diff --git a/_data-prepper/pipelines/configuration/processors/geoip.md b/_data-prepper/pipelines/configuration/processors/geoip.md index b7418c66c6..d0b6bd1cbb 100644 --- a/_data-prepper/pipelines/configuration/processors/geoip.md +++ b/_data-prepper/pipelines/configuration/processors/geoip.md @@ -10,7 +10,7 @@ nav_order: 49 The `geoip` processor enriches events with geographic information extracted from IP addresses contained in the events. By default, Data Prepper uses the [MaxMind GeoLite2](https://dev.maxmind.com/geoip/geolite2-free-geolocation-data) geolocation database. -Data Prepper administrators can configure the databases using the [`geoip_service`]({{site.url}}{{site.baseurl}}/data-prepper/managing-data-prepper/extensions/geoip_service) extension configuration. +Data Prepper administrators can configure the databases using the [`geoip_service`]({{site.url}}{{site.baseurl}}/data-prepper/managing-data-prepper/extensions/geoip-service/) extension configuration. ## Usage diff --git a/_data-prepper/pipelines/configuration/processors/mutate-event.md b/_data-prepper/pipelines/configuration/processors/mutate-event.md index 1afb34a970..ff2da6b527 100644 --- a/_data-prepper/pipelines/configuration/processors/mutate-event.md +++ b/_data-prepper/pipelines/configuration/processors/mutate-event.md @@ -11,9 +11,9 @@ nav_order: 65 Mutate event processors allow you to modify events in Data Prepper. The following processors are available: * [add_entries]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/add-entries/) allows you to add entries to an event. -* [convert_entry_type]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/convert_entry_type/) allows you to convert value types in an event. +* [convert_entry_type]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/convert-entry-type/) allows you to convert value types in an event. * [copy_values]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/copy-values/) allows you to copy values within an event. -* [delete_entries]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/delete_entries/) allows you to delete entries from an event. +* [delete_entries]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/delete-entries/) allows you to delete entries from an event. * [list_to_map]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/list-to-map) allows you to convert list of objects from an event where each object contains a `key` field into a map of target keys. * `map_to_list` allows you to convert a map of objects from an event, where each object contains a `key` field, into a list of target keys. * [rename_keys]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/rename-keys/) allows you to rename keys in an event. diff --git a/_data-prepper/pipelines/configuration/processors/otel_metrics.md b/_data-prepper/pipelines/configuration/processors/otel-metrics.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/otel_metrics.md rename to _data-prepper/pipelines/configuration/processors/otel-metrics.md diff --git a/_data-prepper/pipelines/configuration/processors/otel_traces.md b/_data-prepper/pipelines/configuration/processors/otel-traces.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/otel_traces.md rename to _data-prepper/pipelines/configuration/processors/otel-traces.md diff --git a/_data-prepper/pipelines/configuration/processors/parse_ion.md b/_data-prepper/pipelines/configuration/processors/parse-ion.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/parse_ion.md rename to _data-prepper/pipelines/configuration/processors/parse-ion.md diff --git a/_data-prepper/pipelines/configuration/processors/parse_json.md b/_data-prepper/pipelines/configuration/processors/parse-json.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/parse_json.md rename to _data-prepper/pipelines/configuration/processors/parse-json.md diff --git a/_data-prepper/pipelines/configuration/processors/parse_xml.md b/_data-prepper/pipelines/configuration/processors/parse-xml.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/parse_xml.md rename to _data-prepper/pipelines/configuration/processors/parse-xml.md diff --git a/_data-prepper/pipelines/configuration/processors/service_map.md b/_data-prepper/pipelines/configuration/processors/service-map.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/service_map.md rename to _data-prepper/pipelines/configuration/processors/service-map.md diff --git a/_data-prepper/pipelines/configuration/processors/split_string.md b/_data-prepper/pipelines/configuration/processors/split-string.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/split_string.md rename to _data-prepper/pipelines/configuration/processors/split-string.md diff --git a/_data-prepper/pipelines/configuration/processors/string_converter.md b/_data-prepper/pipelines/configuration/processors/string-converter.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/string_converter.md rename to _data-prepper/pipelines/configuration/processors/string-converter.md diff --git a/_data-prepper/pipelines/configuration/processors/substitute_string.md b/_data-prepper/pipelines/configuration/processors/substitute-string.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/substitute_string.md rename to _data-prepper/pipelines/configuration/processors/substitute-string.md diff --git a/_data-prepper/pipelines/configuration/processors/trim_string.md b/_data-prepper/pipelines/configuration/processors/trim-string.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/trim_string.md rename to _data-prepper/pipelines/configuration/processors/trim-string.md diff --git a/_data-prepper/pipelines/configuration/processors/write_json.md b/_data-prepper/pipelines/configuration/processors/write-json.md similarity index 100% rename from _data-prepper/pipelines/configuration/processors/write_json.md rename to _data-prepper/pipelines/configuration/processors/write-json.md diff --git a/_data-prepper/pipelines/configuration/sources/s3.md b/_data-prepper/pipelines/configuration/sources/s3.md index 7b1599f838..5a7d9986e5 100644 --- a/_data-prepper/pipelines/configuration/sources/s3.md +++ b/_data-prepper/pipelines/configuration/sources/s3.md @@ -138,7 +138,7 @@ The `codec` determines how the `s3` source parses each Amazon S3 object. For inc ### `newline` codec -The `newline` codec parses each single line as a single log event. This is ideal for most application logs because each event parses per single line. It can also be suitable for S3 objects that have individual JSON objects on each line, which matches well when used with the [parse_json]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/parse_json/) processor to parse each line. +The `newline` codec parses each single line as a single log event. This is ideal for most application logs because each event parses per single line. It can also be suitable for S3 objects that have individual JSON objects on each line, which matches well when used with the [parse_json]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/parse-json/) processor to parse each line. Use the following options to configure the `newline` codec. diff --git a/_ingest-pipelines/processors/convert.md b/_ingest-pipelines/processors/convert.md index fe92dfebe7..c86f86c9a7 100644 --- a/_ingest-pipelines/processors/convert.md +++ b/_ingest-pipelines/processors/convert.md @@ -7,7 +7,7 @@ redirect_from: - /api-reference/ingest-apis/processors/convert/ --- -This documentation describes using the `convert` processor in OpenSearch ingest pipelines. Consider using the [Data Prepper `convert_entry_type` processor]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/convert_entry_type/), which runs on the OpenSearch cluster, if your use case involves large or complex datasets. +This documentation describes using the `convert` processor in OpenSearch ingest pipelines. Consider using the [Data Prepper `convert_entry_type` processor]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/convert-entry-type/), which runs on the OpenSearch cluster, if your use case involves large or complex datasets. {: .note} # Convert processor diff --git a/_observing-your-data/trace/ta-dashboards.md b/_observing-your-data/trace/ta-dashboards.md index c7cf0a5091..c7ef2117ad 100644 --- a/_observing-your-data/trace/ta-dashboards.md +++ b/_observing-your-data/trace/ta-dashboards.md @@ -48,7 +48,7 @@ The **Trace Analytics** application includes two options: **Services** and **Tra The plugin requires you to use [Data Prepper]({{site.url}}{{site.baseurl}}/data-prepper/) to process and visualize OTel data and relies on the following Data Prepper pipelines for OTel correlations and service map calculations: - [Trace analytics pipeline]({{site.url}}{{site.baseurl}}/data-prepper/common-use-cases/trace-analytics/) -- [Service map pipeline]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/service_map/) +- [Service map pipeline]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/service-map/) ### Standardized telemetry data