Getting Started with OpenTelemetry Rust Logs in 5 Minutes - Exporting logs to user_events by lalitb · Pull Request #2 · lalitb/opentelemetry-rust

lalitb · 2023-09-06T00:44:51Z

Fixes #
Design discussion issue (if applicable) #

Changes

Please provide a brief description of the changes here.

Merge requirement checklist

CONTRIBUTING guidelines followed
Unit tests added/updated (if applicable)
Appropriate CHANGELOG.md files updated for non-trivial, user-facing changes
Changes in public API reviewed (if applicable)

cijothomas · 2023-09-06T01:08:42Z

+
+### How to configure:
+
+1. Create ExporterConfig with below settings:


I think 2,3 here are irrelevant, and we should hide it from users.

step 2 is setting up the provider_name. Will remove step 3.

Or do you mean to add wrapper on top of these APIs to hide from users ?

yes. but it can be done later.
something like loggerProviderBuilder.add_user_event_exporter(provider_name)

Co-authored-by: Cijo Thomas <cithomas@microsoft.com>

reyang · 2023-09-06T04:51:00Z

+
+2. Create LogProcessor instance:
+```rust
+let processor = ReentrantLogProcessor::new("test_provider", None, exporter_config);


Curious - what's the semantic of the first parameter?

It's documented here - https://github.com/microsoft/LinuxTracepoints/tree/main/libeventheader-tracepoint#provider-names :

--clip
A provider is a component that generates events. Each event from a provider is associated with a Provider Name that uniquely identifies the provider.

The provider name should be short, yet descriptive enough to minimize the chance of collision and to help developers track down the component generating the events. Hierarchical namespaces may be useful for provider names, e.g. MyCompany_MyOrg_MyComponent.
-clap

Have added the link in this document.

So a Provider can generate different unique events. In future, we can have each event mapped to a unique EventKeyword. And the combination of ProviderName + EventKeyword + Level represents a tracepoint name.

I don't understand why a LinuxTracepoint provider has something to do with a ReentrantLogProcessor. If you look at the name of ReentrantLogProcessor, it has nothing to do with provider.

Yes, the plan is to move the provider into ExporterConfig for the next release.

Co-authored-by: Reiley Yang <reyang@microsoft.com>

reyang · 2023-09-07T04:34:41Z

+* Rust and Cargo: [Install](https://doc.rust-lang.org/cargo/getting-started/installation.html) them if you haven't.
+* A Linux system with [user_events](https://docs.kernel.org/trace/user_events.html) enabled: Ubuntu 23.10 (once available), or kernel 6.4 or later build with user_events support.
+* Correct Permissions: Linux user(preferable non-root) with write permission to the tracefs.
+* A listener/agent to listen for new events. Or else [perf](https://perf.wiki.kernel.org/index.php/Main_Page) and [decode-perf](https://github.com/microsoft/LinuxTracepoints/tree/main/libeventheader-decode-cpp/tools) tools installed for validation.


What does "or else" mean?

Since this is more of a getting-started example, we don't have to list all possible ways, I suggest that we just provide the most common way or an easy way (e.g. download XYZ tool and use that).

Good point. Only using the perf/decode-perf tool now.

reyang · 2023-09-07T04:38:33Z

-        event_id = 20,
        user_name = "otel user",
-        user_email = "otel@opentelemetry.io"
+        //event_name = "my-event-name",


@cijothomas what's the expected way (end goal) of specifying event name?

It is supposed to be error!( name: "myevent", ...) ref - https://github.com/tokio-rs/tracing/blob/b8c45ccd067a6aebdd9257c5edda6bc90bcf9028/tracing/src/lib.rs#L247

Have updated the example accordingly. Thanks for pointing out.

reyang · 2023-09-07T04:51:06Z

+
+The example code uses `test` as the ProviderName and `1` as the EventKeyword. So, it makes these 5 tracepoints:
+
+* test_L5K1Gtest


This needs to be updated to reflect the provider name change?

Co-authored-by: Reiley Yang <reyang@microsoft.com>

cijothomas · 2023-09-07T17:00:50Z

+### What you need to know:
+
+* [ProviderName](https://github.com/microsoft/LinuxTracepoints/tree/main/libeventheader-tracepoint#provider-names) and [EventKeyword](https://github.com/microsoft/LinuxTracepoints/tree/main/libeventheader-tracepoint#tracepoint-names) can be changed using Exporter configuration.
+* `ProviderGroup` is assigned the value of `ProviderName`.


does the user need to know this?

I thought it is good for them to know that ProviderGroupis not configurable, and also make them understand why myprovider comes twice in tracepoint name myprovider_L5K1Gmyprovider

Got it.! Yea it can be confusing without this to see myprovider twice.

cijothomas · 2023-09-07T17:02:41Z

+$ perf record -e user_events:myprovider_L2K1Gmyprovider
+<ctrl-c after running example code>
+$ decode-perf ./perf.data
+<log data is output here>


can you paste an actual output, so it is easy to compare where things land?

Sure, added now.

Co-authored-by: Cijo Thomas <cithomas@microsoft.com>

github-actions · 2026-06-24T06:56:13Z

Thank you for your contribution! This PR has been automatically marked as stale because it has not had activity in the last 14 days. This may be due to a delay in review on our side or awaiting a response from you; either is fine, and we appreciate your patience.

It will be closed in 14 days if no further activity occurs. Pushing a new commit or leaving a comment will remove the stale label and keep the PR open.

lalitb added 3 commits September 5, 2023 17:35

draft

a92b905

fix link

4727b31

more changes

54317de

cijothomas reviewed Sep 6, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md Outdated

cijothomas reviewed Sep 6, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md Outdated

cijothomas reviewed Sep 6, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md

Update opentelemetry-user-events-logs/examples/README.md

2c1ba71

Co-authored-by: Cijo Thomas <cithomas@microsoft.com>

reyang reviewed Sep 6, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md Outdated

reyang reviewed Sep 6, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md

reyang reviewed Sep 6, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md Outdated

reyang reviewed Sep 6, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md

reyang reviewed Sep 6, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/basic.rs Outdated

reyang reviewed Sep 6, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md Outdated

reyang reviewed Sep 6, 2023

View reviewed changes

lalitb and others added 4 commits September 6, 2023 12:25

review commentS

08e11da

Update opentelemetry-user-events-logs/examples/README.md

32dd960

Co-authored-by: Reiley Yang <reyang@microsoft.com>

more review comments

0f6a986

fix

0d818f1

reyang reviewed Sep 7, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md Outdated

reyang reviewed Sep 7, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md Outdated

reyang reviewed Sep 7, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md Outdated

lalitb and others added 5 commits September 6, 2023 22:33

Update opentelemetry-user-events-logs/examples/README.md

9ded8d5

Co-authored-by: Reiley Yang <reyang@microsoft.com>

Update opentelemetry-user-events-logs/examples/README.md

e5535a7

Co-authored-by: Reiley Yang <reyang@microsoft.com>

review comments

166a4ef

fix prerequisites

b838650

fix prerequisites

175ccc4

lalitb and others added 2 commits September 6, 2023 23:05

fix example

4f05498

Update opentelemetry-user-events-logs/examples/README.md

61969ec

Co-authored-by: Reiley Yang <reyang@microsoft.com>

cijothomas reviewed Sep 7, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/README.md Outdated

lalitb added 3 commits September 7, 2023 07:17

fix link

0110652

Fix

0f8fb16

more changes

26be421

cijothomas reviewed Sep 7, 2023

View reviewed changes

Comment thread opentelemetry-user-events-logs/examples/basic.rs Outdated

cijothomas reviewed Sep 7, 2023

View reviewed changes

lalitb and others added 2 commits September 7, 2023 10:22

Update opentelemetry-user-events-logs/examples/basic.rs

991cb64

Co-authored-by: Cijo Thomas <cithomas@microsoft.com>

add log output

b7bfc43

github-actions Bot added the Stale label Jun 24, 2026


		### How to configure:

		1. Create ExporterConfig with below settings:


		The example code uses `test` as the ProviderName and `1` as the EventKeyword. So, it makes these 5 tracepoints:

		* test_L5K1Gtest

Conversation

lalitb commented Sep 6, 2023

Changes

Merge requirement checklist

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lalitb Sep 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lalitb Sep 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lalitb Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lalitb Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lalitb Sep 6, 2023 •

edited

Loading

lalitb Sep 6, 2023 •

edited

Loading

lalitb Sep 7, 2023 •

edited

Loading

lalitb Sep 7, 2023 •

edited

Loading