Skip to content

Add River RPC span classification attributes #383

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

Closed
daweifeng-replit wants to merge 1 commit into from
+96 −11
Closed

Add River RPC span classification attributes #383

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
42 changes: 32 additions & 10 deletions tracing/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,26 @@ export interface TelemetryInfo {
ctx: Context;
}

function createProcedureAttributes(
kind: ValidProcType,
serviceName: string,
procedureName: string,
streamId: string,
) {
return {
component: 'river',
'rpc.system': 'river',
'rpc.service': serviceName,
'rpc.method': procedureName,
'river.method.kind': kind,
'river.method.service': serviceName,
'river.method.name': procedureName,
'river.rpc.kind': kind,
'river.rpc.streaming': kind !== 'rpc',
'river.streamId': streamId,
};
}

export function getPropagationContext(
ctx: Context,
): PropagationContext | undefined {
Expand Down Expand Up @@ -101,11 +121,12 @@ export function createProcTelemetryInfo(
`river.client.${serviceName}.${procedureName}`,
{
attributes: {
component: 'river',
'river.method.kind': kind,
'river.method.service': serviceName,
'river.method.name': procedureName,
'river.streamId': streamId,
...createProcedureAttributes(
kind,
serviceName,
procedureName,
streamId,
),
'span.kind': 'client',
},
links: [{ context: session.telemetry.span.spanContext() }],
Expand Down Expand Up @@ -153,11 +174,12 @@ export function createHandlerSpan<Fn extends (span: Span) => unknown>(
`river.server.${serviceName}.${procedureName}`,
{
attributes: {
component: 'river',
'river.method.kind': kind,
'river.method.service': serviceName,
'river.method.name': procedureName,
'river.streamId': streamId,
...createProcedureAttributes(
kind,
serviceName,
procedureName,
streamId,
),
'span.kind': 'server',
},
links: [{ context: session.telemetry.span.spanContext() }],
Expand Down
65 changes: 64 additions & 1 deletion tracing/tracing.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,12 @@ import {
} from '@opentelemetry/sdk-trace-base';
import { W3CTraceContextPropagator } from '@opentelemetry/core';
import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
import { createSessionTelemetryInfo, getPropagationContext } from './index';
import {
createHandlerSpan,
createProcTelemetryInfo,
createSessionTelemetryInfo,
getPropagationContext,
} from './index';
import { testMatrix } from '../testUtil/fixtures/matrix';
import {
cleanupTransports,
Expand Down Expand Up @@ -65,6 +70,64 @@ describe('Basic tracing tests', () => {
) as Span,
).toBeTruthy();
});

test('procedure spans include rpc classification attributes', () => {
spanExporter.reset();
const tracer = trace.getTracer('test');
const session = dummySession();

const { span: clientSpan } = createProcTelemetryInfo(
tracer,
session,
'subscription',
'example',
'watch',
'client-stream-id',
);
clientSpan.end();

createHandlerSpan(
tracer,
session,
'stream',
'example',
'chat',
'server-stream-id',
undefined,
(span) => {
span.end();
},
);

const spans = spanExporter.getFinishedSpans();
const clientProcSpan = spans.find(
(span) => span.name === 'river.client.example.watch',
);
const serverProcSpan = spans.find(
(span) => span.name === 'river.server.example.chat',
);

expect(clientProcSpan?.attributes).toMatchObject({
'rpc.system': 'river',
'rpc.service': 'example',
'rpc.method': 'watch',
'river.method.kind': 'subscription',
'river.rpc.kind': 'subscription',
'river.rpc.streaming': true,
'river.streamId': 'client-stream-id',
'span.kind': 'client',
});
expect(serverProcSpan?.attributes).toMatchObject({
'rpc.system': 'river',
'rpc.service': 'example',
'rpc.method': 'chat',
'river.method.kind': 'stream',
'river.rpc.kind': 'stream',
'river.rpc.streaming': true,
'river.streamId': 'server-stream-id',
'span.kind': 'server',
});
});
});

describe.each(testMatrix())(
Expand Down
Loading