From bf5729f727694a053ee977b9eee3ff2644a8b729 Mon Sep 17 00:00:00 2001 From: Mike Terhar Date: Mon, 9 Dec 2024 18:02:24 +0000 Subject: [PATCH] do codeboten's suggestions --- receiver/libhoneyreceiver/README.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/receiver/libhoneyreceiver/README.md b/receiver/libhoneyreceiver/README.md index c94d4604a2900..a87c8735d5d0e 100644 --- a/receiver/libhoneyreceiver/README.md +++ b/receiver/libhoneyreceiver/README.md @@ -12,12 +12,13 @@ ### The purpose and use-cases of the new component -The Libhoney receiver will accept data for either Trace or Logs signals that are emitted from applications that were instrumented using Libhoney libraries. - +The Libhoney receiver will accept data for either Trace or Logs signals that are emitted from applications that were +instrumented using [Libhoney](https://docs.honeycomb.io/send-data/logs/structured/libhoney/) libraries. ## Configuration -The configuration has 2 parts, One is the HTTP receiver configuration and the rest is about mapping attributes from the freeform libhoney format into the more structured OpenTelemetry objects. +The configuration has 2 parts, One is the HTTP receiver configuration and the rest is about mapping attributes from the +freeform libhoney format into the more structured OpenTelemetry objects. ### Example configuration for the component @@ -62,16 +63,8 @@ The following setting is required for refinery traffic since: ### Telemetry data types supported -It will subscribe to the Traces and Logs signals but accept traffic destined for either pipeline using one http receiver component. Libhoney does not differentiate between the two so the receiver will identify which pipeline to deliver the spans or log records to. +It will subscribe to the Traces and Logs signals but accept traffic destined for either pipeline using one http receiver +component. Libhoney doesnot differentiate between the two so the receiver will identify which pipeline to deliver the +spans or log records to. No support for metrics since they'd look just like logs. - -### Code Owner(s) - -Tyler Helmuth, Mike Terhar - -### Sponsor (optional) - -Tyler Helmuth - -### Additional context \ No newline at end of file