[Instrumentation.StackExchangeRedis] Metrics support #1982

tiagodaraujo · 2024-07-30T08:36:36Z

Fixes #1742
Design discussion issue #

Changes

Add the StackExchangeRedis Meter

Merge requirement checklist

CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes
Changes in public API reviewed (if applicable)

linux-foundation-easycla · 2024-07-30T08:36:43Z

The committers listed above are authorized under a signed CLA.

✅ login: tiagodaraujo / name: Tiago Araujo (4310c07, c34fac6, cc0b39b, 03de3d1, d8abc88, 090733b, 7350e77, da4abbc)
✅ login: Coelho04 / name: Pedro Miguel Almeida Coelho (d456eda, 9c360b9, 9870836, fdba7d3)
✅ login: Kielek / name: Piotr Kiełkowicz (b0f79a4, 067ae78)

matt-hensley · 2024-07-30T21:28:53Z

New database metric semantic conventions are being worked on and should be stabilized soon. It doesn't look what was proposed in open-telemetry/opentelemetry-specification#2070 made it to the spec

You can see the current progress in the semantic convention repo:
https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-metrics.md

It's been requested to not implement the new metrics until they are marked as stable.

That being said, the work here is useful, as converting redis.client.request.duration to the new db.client.operation.duration looks straightforward.

...elemetry.Instrumentation.StackExchangeRedis/Implementation/RedisProfilerEntryInstrumenter.cs

codecov · 2024-07-30T21:53:52Z

Codecov Report

Attention: Patch coverage is 94.16667% with 7 lines in your changes missing coverage. Please review.

Project coverage is 70.83%. Comparing base (71655ce) to head (067ae78).
Report is 453 commits behind head on main.

Files with missing lines	Patch %	Lines
...tackExchangeRedisMeterProviderBuilderExtensions.cs	72.72%	3 Missing ⚠️
....StackExchangeRedis/Implementation/RedisMetrics.cs	87.50%	2 Missing ⚠️
...s/Implementation/RedisProfilerEntryInstrumenter.cs	97.56%	1 Missing ⚠️
...dis/StackExchangeRedisInstrumentationExtensions.cs	97.22%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1982      +/-   ##
==========================================
- Coverage   73.91%   70.83%   -3.09%     
==========================================
  Files         267      338      +71     
  Lines        9615    12587    +2972     
==========================================
+ Hits         7107     8916    +1809     
- Misses       2508     3671    +1163

Flag	Coverage Δ
unittests-Exporter.Geneva	`53.32% <ø> (?)`
unittests-Exporter.InfluxDB	`95.88% <ø> (?)`
unittests-Exporter.Instana	`71.24% <ø> (?)`
unittests-Exporter.OneCollector	`94.32% <ø> (?)`
unittests-Exporter.Stackdriver	`75.73% <ø> (?)`
unittests-Extensions	`88.57% <ø> (?)`
unittests-Extensions.AWS	`83.41% <ø> (?)`
unittests-Extensions.Enrichment	`100.00% <ø> (?)`
unittests-Instrumentation.AWS	`84.78% <ø> (?)`
unittests-Instrumentation.AWSLambda	`88.92% <ø> (?)`
unittests-Instrumentation.AspNet	`76.73% <ø> (?)`
unittests-Instrumentation.AspNetCore	`85.27% <ø> (?)`
unittests-Instrumentation.ConfluentKafka	`13.32% <ø> (?)`
unittests-Instrumentation.ElasticsearchClient	`79.87% <ø> (?)`
unittests-Instrumentation.EntityFrameworkCore	`55.49% <ø> (?)`
unittests-Instrumentation.EventCounters	`76.36% <ø> (?)`
unittests-Instrumentation.GrpcNetClient	`79.61% <ø> (?)`
unittests-Instrumentation.Hangfire	`93.58% <ø> (?)`
unittests-Instrumentation.Http	`82.05% <ø> (?)`
unittests-Instrumentation.Owin	`85.97% <ø> (?)`
unittests-Instrumentation.Process	`100.00% <ø> (?)`
unittests-Instrumentation.Quartz	`78.94% <ø> (?)`
unittests-Instrumentation.Runtime	`100.00% <ø> (?)`
unittests-Instrumentation.SqlClient	`91.89% <ø> (?)`
unittests-Instrumentation.StackExchangeRedis	`72.18% <94.16%> (?)`
unittests-Instrumentation.Wcf	`78.47% <ø> (?)`
unittests-PersistentStorage	`65.78% <ø> (?)`
unittests-Resources.AWS	`77.93% <ø> (?)`
unittests-Resources.Azure	`82.35% <ø> (?)`
unittests-Resources.Container	`72.41% <ø> (?)`
unittests-Resources.Gcp	`72.54% <ø> (?)`
unittests-Resources.Host	`72.64% <ø> (?)`
unittests-Resources.OperatingSystem	`77.20% <ø> (?)`
unittests-Resources.Process	`100.00% <ø> (?)`
unittests-Resources.ProcessRuntime	`94.11% <ø> (?)`
unittests-Sampler.AWS	`87.61% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...dis/StackExchangeRedisConnectionInstrumentation.cs	`98.57% <100.00%> (+1.51%)`	⬆️
...ExchangeRedis/StackExchangeRedisInstrumentation.cs	`100.00% <100.00%> (ø)`
...ackExchangeRedisTracerProviderBuilderExtensions.cs	`66.66% <100.00%> (ø)`
...s/Implementation/RedisProfilerEntryInstrumenter.cs	`43.97% <97.56%> (ø)`
...dis/StackExchangeRedisInstrumentationExtensions.cs	`97.22% <97.22%> (ø)`
....StackExchangeRedis/Implementation/RedisMetrics.cs	`87.50% <87.50%> (ø)`
...tackExchangeRedisMeterProviderBuilderExtensions.cs	`72.72% <72.72%> (ø)`

... and 357 files with indirect coverage changes

Kielek

Could you please fix dotnet-format issues?

src/OpenTelemetry.Instrumentation.StackExchangeRedis/CHANGELOG.md

tiagodaraujo · 2024-07-31T16:41:42Z

@matt-hensley, like you said, at least the redis.client.request.duration follows the convention.

I changed all the attributes, including the tracing ones, paying attention to the 1.26.0 db convention.

There is nothing in the convention for the queue and server time, so I suggest redis.client.queue.duration and redis.client.network.duration. They may be useful in understanding redis.client.request.duration better as it can fluctuate depending on the queue time or the waiting time for the server.

A chart to try to show the request, queue and network timeline.

client.request |---------------------------|
client.queue     |----|
client.network        |-------------------|

We could have the processing time on the client which would be: client.processing = client.request - client.queue - client.network. But I'll leave this one aside for discussion if you think it's relevant.

What do you think about this and what can we do next?

Thanks in advance

Kielek · 2024-08-01T08:18:27Z

@tiagodaraujo, for future changes, could you please add additional commits to the PR instead of force upgrades? It is a bit easier to follow. While merging we are squashing everything to one commit.

src/OpenTelemetry.Instrumentation.StackExchangeRedis/Implementation/RedisMetrics.cs

src/Shared/SemanticConventions.cs

github-actions · 2024-09-12T03:16:47Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

ysolomchenko

~~Make this change to see the test results~~

src/OpenTelemetry.Instrumentation.StackExchangeRedis/Implementation/RedisMetrics.cs

…ation/RedisMetrics.cs Co-authored-by: Piotr Kiełkowicz <[email protected]>

Kielek

First round. I need to think about public contract.

Kielek · 2024-09-17T10:13:22Z

src/OpenTelemetry.Instrumentation.StackExchangeRedis/CHANGELOG.md

+* Add `OpenTelemetry.Instrumentation.StackExchangeRedis` meter. Supported metrics:
+ * `db.client.operation.duration`,
+ * `db.client.operation.queue_time`,
+ * `db.client.operation.server_time`.
+ ([#1982](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1982))


As I see only db.client.operation.duration is supported.

Kielek · 2024-09-17T10:20:28Z

src/OpenTelemetry.Instrumentation.StackExchangeRedis/Implementation/RedisMetrics.cs

+
+internal class RedisMetrics : IDisposable
+{
+ internal const string DurationMetricName = "db.client.operation.duration";


It can be private or in lined as used only in one place.

Kielek · 2024-09-17T10:23:09Z

src/OpenTelemetry.Instrumentation.StackExchangeRedis/Implementation/RedisMetrics.cs

+ public RedisMetrics()
+ {
+ this.meter = new Meter(InstrumentationName, InstrumentationVersion);
+
+ this.DurationHistogram = this.meter.CreateHistogram<double>(
+ DurationMetricName,
+ unit: "s",
+ description: "Duration of database client operations.");
+ }
+
+ public static RedisMetrics Instance { get; } = new RedisMetrics();


You have both public (internal) constructor and the static Instance.

Kielek · 2024-09-17T10:59:00Z

src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md

Please check Readme from packages supporting metrics (eg. AspNetCore). It will be great to follow the structure.
Especially List of metrics produced.

Kielek · 2024-09-17T11:01:01Z

...elemetry.Instrumentation.StackExchangeRedis/Implementation/RedisProfilerEntryInstrumenter.cs

+ activity?.SetTag(SemanticConventions.AttributeNetPeerName, host);
+ activity?.SetTag(SemanticConventions.AttributeNetPeerPort, port);


Candidate for separate PR - update semantic convention to 1.27.0. At least for network tags.
Maybe it will be worth to merge it before this PR? Then the final user experience and process review could be better.

Note. net.peer.name is deprecated. It it not only problem here.

Kielek · 2024-09-17T11:13:12Z

...elemetry.Instrumentation.StackExchangeRedis/Implementation/RedisProfilerEntryInstrumenter.cs


- if (activity.IsAllDataRequested)


I think it is worth to keep this functionality. Checks should be cheaper than adding couple of tags.

github-actions · 2024-09-26T03:17:55Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2024-10-16T03:18:22Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

tiagodaraujo requested a review from a team July 30, 2024 08:36

tiagodaraujo had a problem deploying to external July 30, 2024 08:36 — with GitHub Actions Failure

github-actions bot assigned matt-hensley Jul 30, 2024

github-actions bot requested a review from matt-hensley July 30, 2024 08:36

github-actions bot added the comp:instrumentation.stackexchangeredis Things related to OpenTelemetry.Instrumentation.StackExchangeRedis label Jul 30, 2024

tiagodaraujo mentioned this pull request Jul 30, 2024

Metric instrumentation for Redis client #1742

Open

tiagodaraujo force-pushed the feat/add-redis-meter branch from e8ce71c to 53891e6 Compare July 30, 2024 09:41

tiagodaraujo had a problem deploying to external July 30, 2024 09:41 — with GitHub Actions Failure

cijothomas reviewed Jul 30, 2024

View reviewed changes

...elemetry.Instrumentation.StackExchangeRedis/Implementation/RedisProfilerEntryInstrumenter.cs Outdated Show resolved Hide resolved

cijothomas reviewed Jul 30, 2024

View reviewed changes

...elemetry.Instrumentation.StackExchangeRedis/Implementation/RedisProfilerEntryInstrumenter.cs Outdated Show resolved Hide resolved

Kielek reviewed Jul 31, 2024

View reviewed changes

src/OpenTelemetry.Instrumentation.StackExchangeRedis/CHANGELOG.md Outdated Show resolved Hide resolved

tiagodaraujo force-pushed the feat/add-redis-meter branch from 53891e6 to 0c7bbea Compare July 31, 2024 08:05

tiagodaraujo had a problem deploying to external July 31, 2024 08:05 — with GitHub Actions Failure

tiagodaraujo force-pushed the feat/add-redis-meter branch from 0c7bbea to c08e020 Compare July 31, 2024 11:40

tiagodaraujo had a problem deploying to external July 31, 2024 11:41 — with GitHub Actions Failure

tiagodaraujo force-pushed the feat/add-redis-meter branch from c08e020 to d161623 Compare July 31, 2024 16:13

tiagodaraujo had a problem deploying to external July 31, 2024 16:13 — with GitHub Actions Failure

tiagodaraujo force-pushed the feat/add-redis-meter branch from d161623 to 0d0201b Compare July 31, 2024 16:55

tiagodaraujo had a problem deploying to external July 31, 2024 16:55 — with GitHub Actions Failure

tiagodaraujo force-pushed the feat/add-redis-meter branch from 0d0201b to 03afbec Compare July 31, 2024 16:59

tiagodaraujo had a problem deploying to external July 31, 2024 16:59 — with GitHub Actions Failure

tiagodaraujo force-pushed the feat/add-redis-meter branch from 03afbec to 33d9561 Compare August 1, 2024 08:05

tiagodaraujo had a problem deploying to external August 1, 2024 08:05 — with GitHub Actions Failure

cijothomas reviewed Aug 7, 2024

View reviewed changes

src/OpenTelemetry.Instrumentation.StackExchangeRedis/Implementation/RedisMetrics.cs Outdated Show resolved Hide resolved

cijothomas reviewed Aug 7, 2024

View reviewed changes

src/Shared/SemanticConventions.cs Show resolved Hide resolved

tiagodaraujo added 3 commits August 27, 2024 16:50

fix: unit tests

cc0b39b

feat: add attr server.port if is not default 6379

d8abc88

code review

7350e77

tiagodaraujo force-pushed the feat/add-redis-meter branch from b9bb73d to 7350e77 Compare August 27, 2024 16:36

tiagodaraujo had a problem deploying to external August 27, 2024 16:36 — with GitHub Actions Failure

github-actions bot added the Stale label Sep 12, 2024

ysolomchenko reviewed Sep 12, 2024

View reviewed changes

Merge branch 'main' into feat/add-redis-meter

b0f79a4

Kielek had a problem deploying to external September 12, 2024 14:22 — with GitHub Actions Failure

github-actions bot removed the Stale label Sep 13, 2024

Merge branch 'open-telemetry:main' into feat/add-redis-meter

d456eda

Coelho04 had a problem deploying to external September 16, 2024 09:30 — with GitHub Actions Failure

Kielek reviewed Sep 16, 2024

View reviewed changes

src/OpenTelemetry.Instrumentation.StackExchangeRedis/Implementation/RedisMetrics.cs Outdated Show resolved Hide resolved

Update src/OpenTelemetry.Instrumentation.StackExchangeRedis/Implement…

9c360b9

…ation/RedisMetrics.cs Co-authored-by: Piotr Kiełkowicz <[email protected]>

Coelho04 had a problem deploying to external September 16, 2024 11:46 — with GitHub Actions Failure

Merge branch 'main' into feat/add-redis-meter

067ae78

Kielek had a problem deploying to external September 17, 2024 09:28 — with GitHub Actions Failure

Kielek reviewed Sep 17, 2024

View reviewed changes

luke6Lh43 mentioned this pull request Sep 24, 2024

Redis attributes not aligned with latest semantic conventions #2098

Open

github-actions bot added the Stale label Sep 26, 2024

Merge branch 'open-telemetry:main' into feat/add-redis-meter

9870836

Coelho04 requested a review from a team as a code owner September 30, 2024 08:34

Coelho04 requested a deployment to external September 30, 2024 08:34 — with GitHub Actions Waiting

github-actions bot removed the Stale label Oct 1, 2024

Merge branch 'main' into feat/add-redis-meter

fdba7d3

Coelho04 requested a deployment to external October 8, 2024 14:22 — with GitHub Actions Waiting

github-actions bot added the Stale label Oct 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Instrumentation.StackExchangeRedis] Metrics support #1982

[Instrumentation.StackExchangeRedis] Metrics support #1982

tiagodaraujo commented Jul 30, 2024 •

edited

Loading

linux-foundation-easycla bot commented Jul 30, 2024 •

edited

Loading

matt-hensley commented Jul 30, 2024

codecov bot commented Jul 30, 2024 •

edited

Loading

Kielek left a comment

tiagodaraujo commented Jul 31, 2024 •

edited

Loading

Kielek commented Aug 1, 2024

github-actions bot commented Sep 12, 2024

ysolomchenko left a comment •

edited

Loading

Kielek left a comment

Kielek Sep 17, 2024

Kielek Sep 17, 2024

Kielek Sep 17, 2024

Kielek Sep 17, 2024

Kielek Sep 17, 2024

Kielek Sep 17, 2024

github-actions bot commented Sep 26, 2024

github-actions bot commented Oct 16, 2024

		activity?.SetTag(SemanticConventions.AttributeNetPeerName, host);
		activity?.SetTag(SemanticConventions.AttributeNetPeerPort, port);

[Instrumentation.StackExchangeRedis] Metrics support #1982

Are you sure you want to change the base?

[Instrumentation.StackExchangeRedis] Metrics support #1982

Conversation

tiagodaraujo commented Jul 30, 2024 • edited Loading

Changes

Merge requirement checklist

linux-foundation-easycla bot commented Jul 30, 2024 • edited Loading

matt-hensley commented Jul 30, 2024

codecov bot commented Jul 30, 2024 • edited Loading

Codecov Report

Kielek left a comment

Choose a reason for hiding this comment

tiagodaraujo commented Jul 31, 2024 • edited Loading

Kielek commented Aug 1, 2024

github-actions bot commented Sep 12, 2024

ysolomchenko left a comment • edited Loading

Choose a reason for hiding this comment

Kielek left a comment

Choose a reason for hiding this comment

Kielek Sep 17, 2024

Choose a reason for hiding this comment

Kielek Sep 17, 2024

Choose a reason for hiding this comment

Kielek Sep 17, 2024

Choose a reason for hiding this comment

Kielek Sep 17, 2024

Choose a reason for hiding this comment

Kielek Sep 17, 2024

Choose a reason for hiding this comment

Kielek Sep 17, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 26, 2024

github-actions bot commented Oct 16, 2024

tiagodaraujo commented Jul 30, 2024 •

edited

Loading

linux-foundation-easycla bot commented Jul 30, 2024 •

edited

Loading

codecov bot commented Jul 30, 2024 •

edited

Loading

tiagodaraujo commented Jul 31, 2024 •

edited

Loading

ysolomchenko left a comment •

edited

Loading