Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 19 additions & 14 deletions packages/core/src/attributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@ type AttributeTypeMap = {
integer: number;
double: number;
boolean: boolean;
'string[]': Array<string>;
'integer[]': Array<number>;
'double[]': Array<number>;
'boolean[]': Array<boolean>;
array: Array<string> | Array<number> | Array<boolean>;
};

/* Generates a type from the AttributeTypeMap like:
Expand Down Expand Up @@ -66,9 +63,9 @@ export function isAttributeObject(maybeObj: unknown): maybeObj is AttributeObjec
/**
* Converts an attribute value to a typed attribute value.
*
* For now, we intentionally only support primitive values and attribute objects with primitive values.
* If @param useFallback is true, we stringify non-primitive values to a string attribute value. Otherwise
* we return `undefined` for unsupported values.
* For now, we support primitive values and homogeneous arrays of primitives, either raw or
* inside attribute objects. If @param useFallback is true, we stringify other non-primitive values
* to a string attribute value. Otherwise we return `undefined` for unsupported values.
*
* @param value - The value of the passed attribute.
* @param useFallback - If true, unsupported values will be stringified to a string attribute value.
Expand Down Expand Up @@ -170,17 +167,18 @@ function estimatePrimitiveSizeInBytes(value: Primitive): number {
}

/**
* NOTE: We intentionally do not return anything for non-primitive values:
* - array support will come in the future but if we stringify arrays now,
* sending arrays (unstringified) later will be a subtle breaking change.
* NOTE: We return typed attributes for primitives and homogeneous arrays of primitives:
* - Homogeneous primitive arrays ship with `type: 'array'` (Relay's wire tag for arrays).
* - Mixed-type and nested arrays are not supported and return undefined.
* - Objects are not supported yet and product support is still TBD.
* - We still keep the type signature for TypedAttributeValue wider to avoid a
* breaking change once we add support for non-primitive values.
* - Once we go back to supporting arrays and stringifying all other values,
* we already implemented the serialization logic here:
* https://github.com/getsentry/sentry-javascript/pull/18165
* breaking change once we add support for other non-primitive values.
*/
function getTypedAttributeValue(value: unknown): TypedAttributeValue | void {
if (Array.isArray(value) && isHomogeneousPrimitiveArray(value)) {
return { value, type: 'array' };
}

const primitiveType =
typeof value === 'string'
? 'string'
Expand All @@ -201,3 +199,10 @@ function getTypedAttributeValue(value: unknown): TypedAttributeValue | void {
return { value, type: primitiveType };
}
}

function isHomogeneousPrimitiveArray(arr: unknown[]): boolean {
if (arr.length === 0) return true;
const t = typeof arr[0];
if (t !== 'string' && t !== 'number' && t !== 'boolean') return false;
return arr.every(v => typeof v === t);
}
2 changes: 2 additions & 0 deletions packages/core/src/semanticAttributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ export const SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID = 'sentry.segment.id';
export const SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME = 'sentry.sdk.name';
/** The version of the Sentry SDK */
export const SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION = 'sentry.sdk.version';
/** The list of integrations enabled in the Sentry SDK (e.g., ["InboundFilters", "BrowserTracing"]) */
export const SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS = 'sentry.sdk.integrations';

/** The user ID (gated by sendDefaultPii) */
export const SEMANTIC_ATTRIBUTE_USER_ID = 'user.id';
Expand Down
11 changes: 11 additions & 0 deletions packages/core/src/tracing/spans/captureSpan.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import type { ScopeData } from '../../scope';
import {
SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT,
SEMANTIC_ATTRIBUTE_SENTRY_RELEASE,
SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS,
SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID,
Expand Down Expand Up @@ -53,6 +54,7 @@ export function captureSpan(span: Span, client: Client): SerializedStreamedSpanW

if (spanJSON.is_segment) {
applyScopeToSegmentSpan(spanJSON, finalScopeData);
applySdkMetadataToSegmentSpan(spanJSON, client);
// Allow hook subscribers to mutate the segment span JSON
// This also invokes the `processSegmentSpan` hook of all integrations
client.emit('processSegmentSpan', spanJSON);
Expand Down Expand Up @@ -90,6 +92,15 @@ function applyScopeToSegmentSpan(_segmentSpanJSON: StreamedSpanJSON, _scopeData:
// This will follow in a separate PR
}

function applySdkMetadataToSegmentSpan(segmentSpanJSON: StreamedSpanJSON, client: Client): void {
const integrationNames = client.getOptions().integrations.map(i => i.name);
if (!integrationNames.length) return;

safeSetSpanJSONAttributes(segmentSpanJSON, {
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS]: integrationNames,
});
}

function applyCommonSpanAttributes(
spanJSON: StreamedSpanJSON,
serializedSegmentSpan: StreamedSpanJSON,
Expand Down
90 changes: 44 additions & 46 deletions packages/core/test/lib/attributes.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,33 +76,38 @@ describe('attributeValueToTypedAttributeValue', () => {
);
});

describe('invalid values (non-primitives)', () => {
it.each([
['foo', 'bar'],
[1, 2, 3],
[true, false, true],
[1, 'foo', true],
{ foo: 'bar' },
() => 'test',
Symbol('test'),
])('returns undefined for non-primitive raw values (%s)', value => {
const result = attributeValueToTypedAttributeValue(value);
expect(result).toBeUndefined();
});
describe('homogeneous primitive arrays', () => {
it.each([[['foo', 'bar']], [[1, 2, 3]], [[true, false, true]], [[] as unknown[]]])(
'emits a typed array attribute for raw value %j',
value => {
const result = attributeValueToTypedAttributeValue(value);
expect(result).toStrictEqual({ value, type: 'array' });
},
);

it.each([
['foo', 'bar'],
[1, 2, 3],
[true, false, true],
[1, 'foo', true],
{ foo: 'bar' },
() => 'test',
Symbol('test'),
])('returns undefined for non-primitive attribute object values (%s)', value => {
const result = attributeValueToTypedAttributeValue({ value });
expect(result).toBeUndefined();
it('emits a typed array attribute for attribute object values', () => {
const result = attributeValueToTypedAttributeValue({ value: ['foo', 'bar'] });
expect(result).toStrictEqual({ value: ['foo', 'bar'], type: 'array' });
});
});

describe('invalid values (non-primitives)', () => {
it.each([[[1, 'foo', true]], [{ foo: 'bar' }], [() => 'test'], [Symbol('test')]])(
'returns undefined for non-primitive raw values (%s)',
value => {
const result = attributeValueToTypedAttributeValue(value);
expect(result).toBeUndefined();
},
);

it.each([[[1, 'foo', true]], [{ foo: 'bar' }], [() => 'test'], [Symbol('test')]])(
'returns undefined for non-primitive attribute object values (%s)',
value => {
const result = attributeValueToTypedAttributeValue({ value });
expect(result).toBeUndefined();
},
);
});
});

describe('with fallback=true', () => {
Expand Down Expand Up @@ -189,26 +194,10 @@ describe('attributeValueToTypedAttributeValue', () => {
});

describe('invalid values (non-primitives) - stringified fallback', () => {
it('stringifies string arrays', () => {
const result = attributeValueToTypedAttributeValue(['foo', 'bar'], true);
it('stringifies mixed-type arrays (not homogeneous)', () => {
const result = attributeValueToTypedAttributeValue(['foo', 1, true], true);
expect(result).toStrictEqual({
value: '["foo","bar"]',
type: 'string',
});
});

it('stringifies number arrays', () => {
const result = attributeValueToTypedAttributeValue([1, 2, 3], true);
expect(result).toStrictEqual({
value: '[1,2,3]',
type: 'string',
});
});

it('stringifies boolean arrays', () => {
const result = attributeValueToTypedAttributeValue([true, false, true], true);
expect(result).toStrictEqual({
value: '[true,false,true]',
value: '["foo",1,true]',
type: 'string',
});
});
Expand Down Expand Up @@ -425,15 +414,17 @@ describe('serializeAttributes', () => {
describe('invalid (non-primitive) values', () => {
it("doesn't fall back to stringification by default", () => {
const result = serializeAttributes({ foo: { some: 'object' }, bar: [1, 2, 3], baz: () => {} });
expect(result).toStrictEqual({});
expect(result).toStrictEqual({
bar: { type: 'array', value: [1, 2, 3] },
});
});

it('falls back to stringification of unsupported non-primitive values if fallback is true', () => {
const result = serializeAttributes({ foo: { some: 'object' }, bar: [1, 2, 3], baz: () => {} }, true);
expect(result).toStrictEqual({
bar: {
type: 'string',
value: '[1,2,3]',
type: 'array',
value: [1, 2, 3],
},
baz: {
type: 'string',
Expand All @@ -445,5 +436,12 @@ describe('serializeAttributes', () => {
},
});
});

it('drops mixed-type arrays by default and stringifies them with fallback', () => {
expect(serializeAttributes({ mixed: ['a', 1] })).toStrictEqual({});
expect(serializeAttributes({ mixed: ['a', 1] }, true)).toStrictEqual({
mixed: { type: 'string', value: '["a",1]' },
});
});
});
});
10 changes: 9 additions & 1 deletion packages/core/test/lib/logs/internal.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,6 @@ describe('_INTERNAL_captureLog', () => {
scope.setAttribute('scope_2', { value: 38, unit: 'gigabyte' });
scope.setAttributes({
scope_3: true,
// these are invalid since for now we don't support arrays
scope_4: [1, 2, 3],
scope_5: { value: [true, false, true], unit: 'second' },
});
Expand Down Expand Up @@ -229,6 +228,15 @@ describe('_INTERNAL_captureLog', () => {
type: 'boolean',
value: true,
},
scope_4: {
type: 'array',
value: [1, 2, 3],
},
scope_5: {
type: 'array',
value: [true, false, true],
unit: 'second',
},
'sentry.timestamp.sequence': { value: expect.any(Number), type: 'integer' },
});
});
Expand Down
81 changes: 81 additions & 0 deletions packages/core/test/lib/tracing/spans/captureSpan.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_RELEASE,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS,
SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME,
SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID,
Expand Down Expand Up @@ -291,6 +292,86 @@ describe('captureSpan', () => {
});
});

it('adds sentry.sdk.integrations to segment spans as an array attribute', () => {
const client = new TestClient(
getDefaultTestClientOptions({
dsn: 'https://dsn@ingest.f00.f00/1',
tracesSampleRate: 1,
release: '1.0.0',
environment: 'staging',
integrations: [
{ name: 'InboundFilters', setupOnce: () => {} },
{ name: 'BrowserTracing', setupOnce: () => {} },
],
_metadata: {
sdk: {
name: 'sentry.javascript.browser',
version: '9.0.0',
},
},
}),
);

const span = withScope(scope => {
scope.setClient(client);
const span = startInactiveSpan({ name: 'my-span', attributes: { 'sentry.op': 'http.client' } });
span.end();
return span;
});

expect(captureSpan(span, client)).toStrictEqual({
span_id: expect.stringMatching(/^[\da-f]{16}$/),
trace_id: expect.stringMatching(/^[\da-f]{32}$/),
parent_span_id: undefined,
links: undefined,
start_timestamp: expect.any(Number),
name: 'my-span',
end_timestamp: expect.any(Number),
status: 'ok',
is_segment: true,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: { type: 'string', value: 'http.client' },
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: { type: 'string', value: 'manual' },
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: { type: 'integer', value: 1 },
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: { value: 'my-span', type: 'string' },
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: { value: span.spanContext().spanId, type: 'string' },
'sentry.span.source': { value: 'custom', type: 'string' },
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: { value: 'custom', type: 'string' },
[SEMANTIC_ATTRIBUTE_SENTRY_RELEASE]: { value: '1.0.0', type: 'string' },
[SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT]: { value: 'staging', type: 'string' },
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: { value: 'sentry.javascript.browser', type: 'string' },
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: { value: '9.0.0', type: 'string' },
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS]: {
type: 'array',
value: ['InboundFilters', 'BrowserTracing'],
},
},
_segmentSpan: span,
});
});

it('does not add sentry.sdk.integrations to non-segment child spans', () => {
const client = new TestClient(
getDefaultTestClientOptions({
dsn: 'https://dsn@ingest.f00.f00/1',
tracesSampleRate: 1,
integrations: [{ name: 'InboundFilters', setupOnce: () => {} }],
}),
);

const serializedChild = withScope(scope => {
scope.setClient(client);
return startSpan({ name: 'segment' }, () => {
const childSpan = startInactiveSpan({ name: 'child' });
childSpan.end();
return captureSpan(childSpan, client);
});
});

expect(serializedChild.is_segment).toBe(false);
expect(serializedChild.attributes?.[SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS]).toBeUndefined();
});

describe('client hooks', () => {
it('calls processSpan and processSegmentSpan hooks for a segment span', () => {
const client = new TestClient(
Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/lib/tracing/spans/estimateSize.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ describe('estimateSerializedSpanSizeInBytes', () => {
status: 'ok',
is_segment: false,
attributes: {
'item.ids': { type: 'string[]', value: ['id-001', 'id-002', 'id-003', 'id-004', 'id-005'] },
scores: { type: 'double[]', value: [1.1, 2.2, 3.3, 4.4] },
flags: { type: 'boolean[]', value: [true, false, true] },
'item.ids': { type: 'array', value: ['id-001', 'id-002', 'id-003', 'id-004', 'id-005'] },
scores: { type: 'array', value: [1.1, 2.2, 3.3, 4.4] },
flags: { type: 'array', value: [true, false, true] },
},
};

Expand Down
4 changes: 1 addition & 3 deletions packages/core/test/lib/utils/spanUtils.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -622,11 +622,9 @@ describe('spanToJSON', () => {
attr1: { type: 'string', value: 'value1' },
attr2: { type: 'integer', value: 2 },
attr3: { type: 'boolean', value: true },
attr4: { type: 'array', value: [1, 2, 3] },
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: { type: 'string', value: 'test op' },
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: { type: 'string', value: 'auto' },
// notice the absence of `attr4`!
// for now, we don't yet serialize array attributes. This test will fail
// once we allow serializing them.
},
links: [
{
Expand Down
Loading