Skip to content

Commit

Permalink
[chore][processor/logdeduplication] Add README header (#34488)
Browse files Browse the repository at this point in the history
**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
I noticed in the PR introducing this component that the README was
missing the generic header that all other components have. This is added
by `mdatagen` when the README has the `<!-- status autogenerated section
-->` and `<!-- end autogenerated section -->` lines included.

I also removed the section about supported pipelines, as the added
header should make this clear enough.

**Link to tracking Issue:** <Issue number if applicable>

#34118
  • Loading branch information
crobert-1 authored Aug 7, 2024
1 parent 32746f2 commit 5645d92
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions processor/logdeduplicationprocessor/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# Log DeDuplication Processor
This processor is used to deduplicate logs by detecting identical logs over a range of time and emitting a single log with the count of logs that were deduplicated.

## Supported pipelines
- Logs
<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [development]: logs |
| Distributions | [] |
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Aprocessor%2Flogdeduplication%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aprocessor%2Flogdeduplication) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Aprocessor%2Flogdeduplication%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aprocessor%2Flogdeduplication) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@BinaryFissionGames](https://www.github.com/BinaryFissionGames), [@MikeGoldsmith](https://www.github.com/MikeGoldsmith), [@djaglowski](https://www.github.com/djaglowski) |

[development]: https://github.com/open-telemetry/opentelemetry-collector#development
<!-- end autogenerated section -->

This processor is used to deduplicate logs by detecting identical logs over a range of time and emitting a single log with the count of logs that were deduplicated.

## How It Works
1. The user configures the log deduplication processor in the desired logs pipeline.
Expand Down

0 comments on commit 5645d92

Please sign in to comment.