Semantic conventions for Real User Monitoring

open-telemetry / opentelemetry-specification

Specifications for OpenTelemetry

https://opentelemetry.io

Apache License 2.0

3.64k stars 871 forks source link

Semantic conventions for Real User Monitoring #1679

Open ivomagi opened 3 years ago

ivomagi commented 3 years ago

What are you trying to achieve?

When building a Real User Monitoring solution for browser-based web applications, we have stumbled upon issues where current semantic conventions in OpenTelemetry do not seem to model the client-side too well. The conventions seem to be designed with server-side focus, resulting in some of the concepts not (directly) applicable to the client-side telemetry.

Looking for interested people to discuss the problems and potential solutions in the field. So if you are working with either Browser or Mobile RUM products and have an interest in any of the following topics, help to plot out a path forward for client-side semantic conventions is appreciated:

[ ] Issue #1680 - Representing resources
[ ] Issue #1681 - Representing application as services?
[ ] Issue #1682 - Representing events with no operation/span mapping
[ ] Issue #1683 - Representing Websockets

svrnm commented 3 years ago

For all of those questions, there might be an (inofficial) answer in the existing implementation with JS / JS-Contrib:

https://www.npmjs.com/package/@opentelemetry/web and more: https://www.npmjs.com/package/@opentelemetry/plugin-react-load https://www.npmjs.com/package/@opentelemetry/instrumentation-document-load https://www.npmjs.com/package/@opentelemetry/instrumentation-user-interaction

ivomagi commented 3 years ago

For all of those questions, there might be an (inofficial) answer in the existing implementation with JS / JS-Contrib:

https://www.npmjs.com/package/@opentelemetry/web and more: https://www.npmjs.com/package/@opentelemetry/plugin-react-load https://www.npmjs.com/package/@opentelemetry/instrumentation-document-load https://www.npmjs.com/package/@opentelemetry/instrumentation-user-interaction

Unfortunately no. We have studied the opentelemetry-js and opentelemetry-js-contrib repositories while building the RUM product, but exactly on the areas highlighted in this ticket there is no answer in the current SDK nor contrib.

reyang commented 3 years ago

@ivomagi please also reach out on the Slack channel, and verify the approach/proposal via some real instrumentation libraries.

pmm-sumo commented 3 years ago

This brings some good topics and I think we could throw few more items with @kkruk-sumo that we've been thinking about. For example:

a standard way to define the ID of the page - e.g. based on page title or URL
including http.page_title - see https://github.com/open-telemetry/opentelemetry-specification/pull/1630 (now closed)
handling clock inaccuracies (which I believe might be more common in this scenario) - we proposed https://github.com/open-telemetry/opentelemetry-specification/issues/1270 for that purpose
ability to handle Single-page Applications - e.g. when it's unclear when the page should be considered rendered or so; it might require some extra capabilities to mark it

svrnm commented 3 years ago

I took part in the first few minutes of the meeting yesterday but had to leave early, I just heard that you're looking for people who are open to help with this topic. Just wanted to say, that I'd like to participate.

stefaneberl commented 3 years ago

This topic has been brought to my attention recently. I'm interested in it and would like to participate.

martinkuba commented 3 years ago

Hello! I would like to participate as well.