internal/exp/metrics: identity types #31017

sh0rez · 2024-02-02T12:39:15Z

Adds a new internal, experimental package metrics/identity which implements identity types for resource, scope, metric and stream.

This is closely related to work being done in #30707 and #30827.

The package is specifically experimental, as it shall be treated as an internal component to above processors which may change at any moment as long as those are under active initial development.

/cc @jpkrohling @djaglowski @RichieSams

Adds new internal, _experimental_ package `metrics/identity` which implements identity types for resource, scope, metric and stream.

RichieSams · 2024-02-05T16:15:56Z

internal/exp/metrics/identity/resource.go

+)
+
+type Resource struct {
+	attrs [16]byte


Do we need to include the resource SchemaURL as part of the identifier?

no idea, can someone clarify? @jpkrohling @djaglowski

Yes: https://opentelemetry.io/docs/specs/otel/resource/sdk/#create

This came up in the maintainers meeting yesterday and consensus seemed to be that most language libraries are not setting this field. Technically it is optional so I would be ok with leaving it out for now and adding later if necessary.

RichieSams · 2024-02-05T16:16:18Z

internal/exp/metrics/identity/scope.go

+type Scope struct {
+	res Resource
+
+	name    string


Do we need to include the scope schemaURL as part of the identifier?

Leave it out IMO

RichieSams · 2024-02-05T16:18:31Z

Added some small comments. Overall, I like the approach a lot; the code design is very clean

RichieSams · 2024-02-05T19:25:20Z

internal/exp/metrics/identity/metric.go

+	sum.Write([]byte{byte(i.ty), mono, byte(i.temporality)})
+	return sum
+}
+


Can we add functions for each identity struct to return the "inner" ID? For example:

func (i Metric) Scope() Scope { return i.scope }

So Stream has a Metric(), Metric has a Scope(), and Scope has a Resource().

IE: d9b3edd

yes absolutely, already got to this conclusion during local testing

RichieSams · 2024-02-12T15:05:32Z

@jpkrohling @djaglowski Any thoughts on this PR?

@sh0rez What do you think of my comments about the schemaURL and potentially allowing exposing the "inner" ID?

Can i assist in any way to help get this PR across the finish line? (And subsequently, the follow-up PR for staleness: #31089)

jpkrohling

I'm OK with this change, but it should be discussed with other folks owning metrics components. I also feel like this should be part of core, not contrib.

cc @dmitryax, @codeboten, @mx-psi

jpkrohling · 2024-02-13T12:42:35Z

.github/CODEOWNERS

@@ -100,7 +100,7 @@ extension/storage/filestorage/                           @open-telemetry/collect

 internal/aws/                                            @open-telemetry/collector-contrib-approvers @Aneurysm9 @mxiamxia
 internal/docker/                                         @open-telemetry/collector-contrib-approvers @rmfitzpatrick @jamesmoessis
-
+internal/exp/metrics/                                    @open-telemetry/collector-contrib-approvers @sh0rez


@RichieSams, how do you feel about being a code owner of this with @sh0rez ?

That's fine by me. I already was adding myself in the followup PR: #31089

@RichieSams, you'll have to become a member of the OpenTelemetry org in order to be a code owner. Requirements are here. I'm happy to be one of your sponsors.

that would apply to me as well then. @djaglowski would you be willing to be a sponsor for me as well?

@jpkrohling Would you be willing to be our second sponsor?

open-telemetry/community#1945

djaglowski · 2024-02-13T14:21:57Z

I'm OK with this change, but it should be discussed with other folks owning metrics components.

This looks pretty good to me. Having a dedicated package which handles uniqueness according to our data model will be very helpful. I've seen numerous other implementations, most of which tend to be suboptimal. As a shared package, it can evolve towards correctness and performance without otherwise being a concern of those who work on it.

I also feel like this should be part of core, not contrib.

I agree but in my opinion it makes sense to develop it in contrib and move it to core when it is proven out.

mx-psi

Makes sense to me to have this. Would be good to closely follow the spec, since there are some subtleties involved, and it's also a good opportunity to clarify the spec if it's unclear that a particular attribute is part of the metrics' identity.

RichieSams · 2024-02-15T18:22:27Z

@sh0rez It looks like some CI checks are failing:

Porto links are out of date, please run "make goporto" and commit the changes in this PR

@djaglowski @jpkrohling @mx-psi Once that is fixed, do you have any other comments? Is it ok to merge?

internal/exp/metrics/metadata.yaml

left by accident, no need here

sh0rez · 2024-02-19T12:11:36Z

@RichieSams as a future codeowner, could you approve this PR as well? :)

@jpkrohling

Adds a new internal, _experimental_ package `metrics/identity` which implements identity types for resource, scope, metric and stream. This is closely related to work being done in open-telemetry#30707 and open-telemetry#30827. The package is specifically experimental, as it shall be treated as an internal component to above processors which may change at any moment as long as those are under active initial development. /cc @jpkrohling @djaglowski @RichieSams

@jpkrohling

Adds a new internal, _experimental_ package `metrics/identity` which implements identity types for resource, scope, metric and stream. This is closely related to work being done in open-telemetry#30707 and open-telemetry#30827. The package is specifically experimental, as it shall be treated as an internal component to above processors which may change at any moment as long as those are under active initial development. /cc @jpkrohling @djaglowski @RichieSams

@jpkrohling

Adds a new internal, _experimental_ package `metrics/identity` which implements identity types for resource, scope, metric and stream. This is closely related to work being done in open-telemetry#30707 and open-telemetry#30827. The package is specifically experimental, as it shall be treated as an internal component to above processors which may change at any moment as long as those are under active initial development. /cc @jpkrohling @djaglowski @RichieSams

internal/exp/metrics: identity types

3220bfa

Adds new internal, _experimental_ package `metrics/identity` which implements identity types for resource, scope, metric and stream.

sh0rez mentioned this pull request Feb 2, 2024

[processor/deltatocumulative]: Sums #30707

Merged

3 tasks

RichieSams reviewed Feb 5, 2024

View reviewed changes

RichieSams mentioned this pull request Feb 6, 2024

[internal/exp/metrics] Add a new internal package for handling metric staleness #31089

Merged

sh0rez mentioned this pull request Feb 13, 2024

new component: deltatocumulative processor #30479

Open

jpkrohling reviewed Feb 13, 2024

View reviewed changes

mx-psi reviewed Feb 14, 2024

View reviewed changes

sh0rez marked this pull request as ready for review February 14, 2024 11:13

sh0rez requested a review from a team as a code owner February 14, 2024 11:13

sh0rez requested a review from evan-bradley February 14, 2024 11:13

github-actions bot assigned MovieStoreGuy Feb 14, 2024

sh0rez added 5 commits February 14, 2024 12:15

*: merge main to resolve conflicts

c87eb2d

*: linter fixes

d7535a7

*: remove accidentally commited cmd/testcol

4816837

identity: accessors for embedded values

1aa1c86

*: make goporto

f741d60

jpkrohling added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Feb 14, 2024

RichieSams mentioned this pull request Feb 14, 2024

REQUEST: New membership for RichieSams open-telemetry/community#1945

Closed

6 tasks

sh0rez mentioned this pull request Feb 15, 2024

REQUEST: New membership for @sh0rez open-telemetry/community#1948

Closed

6 tasks

jpkrohling reviewed Feb 19, 2024

View reviewed changes

internal/exp/metrics/metadata.yaml Outdated Show resolved Hide resolved

sh0rez added 4 commits February 19, 2024 12:19

*: add RichieSams to metadata.yaml

9667ae7

*: forward to main

be983d9

identity: remove mdatagen

a379343

left by accident, no need here

*: add to modset

f08f0f4

RichieSams approved these changes Feb 19, 2024

View reviewed changes

jpkrohling approved these changes Feb 19, 2024

View reviewed changes

jpkrohling merged commit 9dc748d into open-telemetry:main Feb 19, 2024
142 checks passed

sh0rez deleted the expmetrics branch February 19, 2024 13:54

github-actions bot added this to the next release milestone Feb 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

internal/exp/metrics: identity types #31017

internal/exp/metrics: identity types #31017

sh0rez commented Feb 2, 2024 •

edited

RichieSams Feb 5, 2024

sh0rez Feb 13, 2024

jpkrohling Feb 13, 2024

djaglowski Feb 13, 2024

RichieSams Feb 5, 2024

djaglowski Feb 13, 2024

RichieSams commented Feb 5, 2024 •

edited

RichieSams Feb 5, 2024

RichieSams Feb 5, 2024

sh0rez Feb 13, 2024

RichieSams commented Feb 12, 2024 •

edited

jpkrohling left a comment

jpkrohling Feb 13, 2024

RichieSams Feb 13, 2024

djaglowski Feb 13, 2024

sh0rez Feb 14, 2024

RichieSams Feb 14, 2024

jpkrohling Feb 14, 2024

RichieSams Feb 14, 2024

djaglowski commented Feb 13, 2024

mx-psi left a comment

RichieSams commented Feb 15, 2024

sh0rez commented Feb 19, 2024

internal/exp/metrics: identity types #31017

internal/exp/metrics: identity types #31017

Conversation

sh0rez commented Feb 2, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RichieSams commented Feb 5, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RichieSams commented Feb 12, 2024 • edited

jpkrohling left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djaglowski commented Feb 13, 2024

mx-psi left a comment

Choose a reason for hiding this comment

RichieSams commented Feb 15, 2024

sh0rez commented Feb 19, 2024

sh0rez commented Feb 2, 2024 •

edited

RichieSams commented Feb 5, 2024 •

edited

RichieSams commented Feb 12, 2024 •

edited