Add OTLP HTTP Log Exporter example using tracing appender. (#1294)

* initial commit

* fix

* remove jaeger exporter

* add service_name as CARGO_BIN_NAME

* remove jaeger container, as we instead use Debug Exporter

* Update opentelemetry-otlp/examples/basic-otlp-http/README.md

Co-authored-by: Cijo Thomas <[email protected]>

* only keep required ports

* read binary name at compile time

---------

Co-authored-by: Cijo Thomas <[email protected]>

Author: lalitb

opentelemetry-otlp/examples/basic-otlp-http/Cargo.toml

@@ -8,6 +8,12 @@ publish = false
 [dependencies]
 once_cell = "1.17"
 opentelemetry = { path = "../../../opentelemetry" }
-opentelemetry_sdk = { path = "../../../opentelemetry-sdk", features = ["rt-tokio", "metrics"] }
-opentelemetry-otlp = { path = "../..", features = ["http-proto", "reqwest-client"] }
+opentelemetry_sdk = { path = "../../../opentelemetry-sdk", features = ["rt-tokio", "metrics", "logs"] }
+opentelemetry-otlp = { path = "../..", features = ["http-proto", "reqwest-client", "logs"] }
+opentelemetry-appender-tracing = { path = "../../../opentelemetry-appender-tracing", default-features = false}
+opentelemetry-semantic-conventions = { path = "../../../opentelemetry-semantic-conventions" }
+
 tokio = { version = "1.0", features = ["full"] }
+tracing-subscriber = { version = "0.3.0", default-features = false, features = ["registry", "std"] }
+tracing = { version = "0.1.37", default-features = false, features = ["std"] }
+tracing-core = "0.1.31"

opentelemetry-otlp/examples/basic-otlp-http/README.md

@@ -1,20 +1,17 @@
 * The application send data directly to a Collector (port 4318)
 * Run the application locally, to run as a docker container you have to change the relative paths from the `Cargo.toml`
-* The Collector then sends the data to the appropriate backend, in this case JAEGER
+* The Collector then sends the data to the appropriate backend, in this case Debug Exporter. The Debug Exporter exports data to console.
 
 This demo uses `docker-compose` and by default runs against the `otel/opentelemetry-collector-dev:latest` image,
 and uses `http` as the transport.
 
 ```shell
 docker-compose up
-or
-docker-compose up -d
 ```
 
 In another terminal run the application `cargo run`
 
-Use the browser to see the trace:
-- Jaeger at http://0.0.0.0:16686
+The docker-compose terminal will display logs, metrics and traces.
 
 Tear it down:
 

opentelemetry-otlp/examples/basic-otlp-http/docker-compose.yaml

@@ -1,14 +1,6 @@
 version: "2"
 services:
 
-  # Jaeger
-  jaeger-all-in-one:
-    image: jaegertracing/all-in-one:latest
-    ports:
-      - "16686:16686"
-      - "14268"
-      - "14250"
-
   # Collector
   otel-collector:
     image: otel/opentelemetry-collector:latest
@@ -18,20 +10,9 @@ services:
     ports:
       - "1888:1888"   # pprof extension
       - "13133:13133" # health_check extension
-      - "4317:4317"   # OTLP gRPC receiver
       - "4318:4318"   # OTLP HTTP receiver
       - "55670:55679" # zpages extension
-    depends_on:
-      - jaeger-all-in-one
 
 
-  # metrics-rust:
-  #   build:
-  #     dockerfile: $PWD/Dockerfile
-  #     context: ./basic-otlp-http
-  #   environment:
-  #     - OTLP_TONIC_ENDPOINT=otel-collector:4317
-  #   depends_on:
-  #     - otel-collector
 
 

opentelemetry-otlp/examples/basic-otlp-http/otel-collector-config.yaml

@@ -1,36 +1,27 @@
+# This is a configuration file for the OpenTelemetry Collector intended to be
+# used in conjunction with the opentelemetry-otlp example.
+#
+# For more information about the OpenTelemetry Collector see:
+#   https://github.com/open-telemetry/opentelemetry-collector
+#
 receivers:
   otlp:
     protocols:
-      http:
       grpc:
+      http:
 
 exporters:
-  logging:
-    loglevel: debug
-
-  jaeger:
-    endpoint: jaeger-all-in-one:14250
-    tls:
-      insecure: true
-
-processors:
-  batch:
-
-extensions:
-  health_check:
-  pprof:
-    endpoint: :1888
-  zpages:
-    endpoint: :55679
+  debug:
+    verbosity: detailed
 
 service:
-  extensions: [pprof, zpages, health_check]
   pipelines:
     traces:
       receivers: [otlp]
-      processors: [batch]
-      exporters: [logging, jaeger]
+      exporters: [debug]
     metrics:
       receivers: [otlp]
-      processors: [batch]
-      exporters: [logging]
+      exporters: [debug]
+    logs:
+      receivers: [otlp]
+      exporters: [debug]

opentelemetry-otlp/examples/basic-otlp-http/src/main.rs

@@ -4,10 +4,34 @@ use opentelemetry::{
     trace::{TraceContextExt, TraceError, Tracer},
     Key, KeyValue,
 };
+use opentelemetry_appender_tracing::layer::OpenTelemetryTracingBridge;
 use opentelemetry_otlp::WithExportConfig;
+use opentelemetry_sdk::logs as sdklogs;
 use opentelemetry_sdk::metrics as sdkmetrics;
+use opentelemetry_sdk::resource;
 use opentelemetry_sdk::trace as sdktrace;
+
 use std::error::Error;
+use tracing::info;
+use tracing_subscriber::prelude::*;
+
+fn init_logs() -> Result<sdklogs::Logger, opentelemetry::logs::LogError> {
+    let service_name = env!("CARGO_BIN_NAME");
+    opentelemetry_otlp::new_pipeline()
+        .logging()
+        .with_log_config(
+            sdklogs::Config::default().with_resource(resource::Resource::new(vec![KeyValue::new(
+                opentelemetry_semantic_conventions::resource::SERVICE_NAME,
+                service_name,
+            )])),
+        )
+        .with_exporter(
+            opentelemetry_otlp::new_exporter()
+                .http()
+                .with_endpoint("http://localhost:4318"),
+        )
+        .install_batch(opentelemetry_sdk::runtime::Tokio)
+}
 
 fn init_tracer() -> Result<sdktrace::Tracer, TraceError> {
     opentelemetry_otlp::new_pipeline()
@@ -51,12 +75,15 @@ static COMMON_ATTRIBUTES: Lazy<[KeyValue; 4]> = Lazy::new(|| {
 async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
     let _ = init_tracer()?;
     let meter_provider = init_metrics()?;
+    let _ = init_logs();
 
     let tracer = global::tracer("ex.com/basic");
     let meter = global::meter("ex.com/basic");
 
-    let histogram = meter.f64_histogram("ex.com.two").init();
-    histogram.record(5.5, COMMON_ATTRIBUTES.as_ref());
+    // configure the global logger to use our opentelemetry logger
+    let logger_provider = opentelemetry::global::logger_provider();
+    let layer = OpenTelemetryTracingBridge::new(&logger_provider);
+    tracing_subscriber::registry().with(layer).init();
 
     tracer.in_span("operation", |cx| {
         let span = cx.span();
@@ -72,10 +99,16 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
 
             span.add_event("Sub span event", vec![]);
         });
+        info!(target: "my-target", "hello from {}. My price is {}. I am also inside a Span!", "banana", 2.99);
     });
+    info!(target: "my-target", "hello from {}. My price is {}", "apple", 1.99);
+
+    let histogram = meter.f64_histogram("ex.com.two").init();
+    histogram.record(5.5, COMMON_ATTRIBUTES.as_ref());
 
-    meter_provider.shutdown()?;
     global::shutdown_tracer_provider();
+    global::shutdown_logger_provider();
+    meter_provider.shutdown()?;
 
     Ok(())
 }

opentelemetry-otlp/examples/basic-otlp/README.md

@@ -2,7 +2,9 @@
 
 This example shows how to setup OpenTelemetry OTLP exporter for logs, metrics
 and traces to exports them to the [OpenTelemetry
-Collector](https://github.com/open-telemetry/opentelemetry-collector) via OTLP.
+Collector](https://github.com/open-telemetry/opentelemetry-collector) via OTLP. 
+The Collector then sends the data to the appropriate backend, in this case 
+Debug Exporter. The Debug Exporter exports data to console.
 
 ## Usage
 
@@ -13,14 +15,11 @@ By default runs against the `otel/opentelemetry-collector-dev:latest` image, and
 
 ```shell
 docker-compose up
-or
-docker-compose up -d
 ```
 
 In another terminal run the application `cargo run`
 
-Use the browser to see the trace:
-- Jaeger at http://0.0.0.0:16686
+The docker-compose terminal will display logs, traces, metrics.
 
 Tear it down:
 
@@ -35,7 +34,7 @@ and inspect the logs to see traces being transferred.
 
 ```shell
 # From the current directory, run `opentelemetry-collector`
-$ docker run --rm -it -p 4317:4317 -p 4318:4318 -v $(pwd):/cfg otel/opentelemetry-collector:latest --config=/cfg/otel-collector-config.yaml
+$ docker run --rm -it -p 4317:4317 -v $(pwd):/cfg otel/opentelemetry-collector:latest --config=/cfg/otel-collector-config.yaml
 
 # Run the app which exports logs, metrics and traces via OTLP to the collector.
 $ cargo run

opentelemetry-otlp/examples/basic-otlp/docker-compose.yaml

@@ -1,14 +1,6 @@
 version: "2"
 services:
 
-  # Jaeger
-  jaeger-all-in-one:
-    image: jaegertracing/all-in-one:latest
-    ports:
-      - "16686:16686"
-      - "14268"
-      - "14250"
-
   # Collector
   otel-collector:
     image: otel/opentelemetry-collector:latest
@@ -19,10 +11,8 @@ services:
       - "1888:1888"   # pprof extension
       - "13133:13133" # health_check extension
       - "4317:4317"   # OTLP gRPC receiver
-      - "4318:4318"   # OTLP HTTP receiver
       - "55670:55679" # zpages extension
-    depends_on:
-      - jaeger-all-in-one
+      
 
 
 

opentelemetry-otlp/examples/basic-otlp/otel-collector-config.yaml

@@ -24,4 +24,4 @@ service:
       exporters: [logging]
     logs:
       receivers: [otlp]
-      exporters: [logging]
+      exporters: [logging]

opentelemetry-otlp/examples/basic-otlp/src/main.rs

@@ -52,12 +52,13 @@ fn init_metrics() -> metrics::Result<MeterProvider> {
 }
 
 fn init_logs() -> Result<opentelemetry_sdk::logs::Logger, LogError> {
+    let service_name = env!("CARGO_BIN_NAME");
     opentelemetry_otlp::new_pipeline()
         .logging()
         .with_log_config(
             Config::default().with_resource(Resource::new(vec![KeyValue::new(
                 opentelemetry_semantic_conventions::resource::SERVICE_NAME,
-                "basic-otlp-logging-example",
+                service_name,
             )])),
         )
         .with_exporter(