Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare release of user-events-metrics exporter #28

Merged
merged 1 commit into from
Jan 26, 2024
Merged

Prepare release of user-events-metrics exporter #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions opentelemetry-user-events-metrics/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

## Unreleased

## v0.2.1

- Update eventheader version to 0.3.4.
[#27](https://github.com/open-telemetry/opentelemetry-rust-contrib/pull/27).

## v0.2.0

- Fix aggregation selector and temporality so every instruments are aggregated
Expand Down
19 changes: 13 additions & 6 deletions opentelemetry-user-events-metrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,21 @@

# OpenTelemetry user_events Exporter

## Overview
[![Crates.io: opentelemetry-user-events-metrics](https://img.shields.io/crates/v/opentelemetry-user-events-metrics.svg)](https://crates.io/crates/opentelemetry-user-events-metrics)

[user_events](https://docs.kernel.org/trace/user_events.html) is Linux solution for user process tracing, similar to ETW (Event Tracing for Windows) on Windows. It builds on top of the Linux Tracepoints, and so allows user processes to create events and trace data that can be viewed via existing tools like ftrace and perf.
This crate contains OpenTelemetry metrics exporter to
[user_events](https://docs.kernel.org/trace/user_events.html) , a Linux solution
for user process tracing, similar to ETW (Event Tracing for Windows) on Windows.
It builds on top of the Linux Tracepoints, and so allows user processes to
create events and trace data that can be viewed via existing tools like ftrace
and perf.

This kernel feature is supported started in Linux kernel 5.18 onwards. The feature enables
- A faster path for tracing from user mode application utilizing kernel mode memory address space.
- User processes can now export telemetry events only when it is useful i.e, when the registered set of tracepoint events are enabled.

- A faster path for tracing from user mode application utilizing kernel mode memory address space.
- User processes can now export telemetry events only when it is useful i.e, when the registered set of tracepoint events are enabled.

This user_events exporter enables applications to use OpenTelemetry API to capture the telemetry events, and write to user_events subsystem. From user_events, the events can be
- Captured by the agents running locally, and listening for specific events withing user_events subsystem.
- Or real-time monitoring using local Linux tool like [perf](https://perf.wiki.kernel.org/index.php/Main_Page) or ftrace.

- Captured by the agents running locally, and listening for specific events withing user_events subsystem.
- Or real-time monitoring using local Linux tool like [perf](https://perf.wiki.kernel.org/index.php/Main_Page) or ftrace.
Loading