Skip to content
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

Jump to bottom

chore: require value in setAttribute #1851

Merged
merged 8 commits into from
Jan 30, 2021
Merged

chore: require value in setAttribute #1851

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b5c8544
chore: require value in setAttribute
mwear Jan 20, 2021
b83d9ef
chore: check for undefined to allow for falsey values
mwear Jan 20, 2021
a1c51c2
Update packages/opentelemetry-instrumentation-fetch/src/fetch.ts
mwear Jan 20, 2021
5076c21
fix: content length of 0 is now recorded from xhr instrumentation
mwear Jan 21, 2021
94d47c6
fix: remove debug logging
mwear Jan 21, 2021
650b275
Merge branch 'main' into require-value-setattribute
vmarchaud Jan 27, 2021
d791d23
Merge branch 'main' into require-value-setattribute
vmarchaud Jan 28, 2021
4ad45c8
Merge branch 'main' into require-value-setattribute
vmarchaud Jan 30, 2021
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
2 changes: 1 addition & 1 deletion packages/opentelemetry-api/src/trace/span.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export interface Span {
* @param value the value for this attribute. Setting a value null or
* undefined is invalid and will result in undefined behavior.
*/
setAttribute(key: string, value?: AttributeValue): this;
setAttribute(key: string, value: AttributeValue): this;

/**
* Sets attributes to the span.
Expand Down
4 changes: 3 additions & 1 deletion packages/opentelemetry-instrumentation-fetch/src/fetch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,9 @@ export class FetchInstrumentation extends InstrumentationBase<
): void {
const parsedUrl = web.parseUrl(response.url);
span.setAttribute(HttpAttribute.HTTP_STATUS_CODE, response.status);
span.setAttribute(HttpAttribute.HTTP_STATUS_TEXT, response.statusText);
if (response.statusText != undefined) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: !== undefined

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we may end up stuck in a loop #1851 (comment)

span.setAttribute(HttpAttribute.HTTP_STATUS_TEXT, response.statusText);
}
span.setAttribute(HttpAttribute.HTTP_HOST, parsedUrl.host);
span.setAttribute(
HttpAttribute.HTTP_SCHEME,
Expand Down
9 changes: 6 additions & 3 deletions packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,12 @@ export class XMLHttpRequestInstrumentation extends InstrumentationBase<XMLHttpRe
_addFinalSpanAttributes(span: api.Span, xhrMem: XhrMem, spanUrl?: string) {
if (typeof spanUrl === 'string') {
const parsedUrl = parseUrl(spanUrl);

span.setAttribute(HttpAttribute.HTTP_STATUS_CODE, xhrMem.status);
span.setAttribute(HttpAttribute.HTTP_STATUS_TEXT, xhrMem.statusText);
if (xhrMem.status !== undefined) {
span.setAttribute(HttpAttribute.HTTP_STATUS_CODE, xhrMem.status);
}
if (xhrMem.statusText !== undefined) {
span.setAttribute(HttpAttribute.HTTP_STATUS_TEXT, xhrMem.statusText);
}
span.setAttribute(HttpAttribute.HTTP_HOST, parsedUrl.host);
span.setAttribute(
HttpAttribute.HTTP_SCHEME,
Expand Down
15 changes: 10 additions & 5 deletions packages/opentelemetry-instrumentation-xml-http-request/test/xhr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -789,29 +789,34 @@ describe('xhr', () => {
);
assert.strictEqual(
attributes[keys[2]],
0,
`attributes ${HttpAttribute.HTTP_REQUEST_CONTENT_LENGTH} is wrong`
);
assert.strictEqual(
attributes[keys[3]],
400,
`attributes ${HttpAttribute.HTTP_STATUS_CODE} is wrong`
);
assert.strictEqual(
attributes[keys[3]],
attributes[keys[4]],
'Bad Request',
`attributes ${HttpAttribute.HTTP_STATUS_TEXT} is wrong`
);
assert.strictEqual(
attributes[keys[4]],
attributes[keys[5]],
'raw.githubusercontent.com',
`attributes ${HttpAttribute.HTTP_HOST} is wrong`
);
assert.ok(
attributes[keys[5]] === 'http' || attributes[keys[5]] === 'https',
attributes[keys[6]] === 'http' || attributes[keys[6]] === 'https',
`attributes ${HttpAttribute.HTTP_SCHEME} is wrong`
);
assert.ok(
attributes[keys[6]] !== '',
attributes[keys[7]] !== '',
`attributes ${HttpAttribute.HTTP_USER_AGENT} is not defined`
);

assert.strictEqual(keys.length, 7, 'number of attributes is wrong');
assert.strictEqual(keys.length, 8, 'number of attributes is wrong');
});

it('span should have correct events', () => {
Expand Down
5 changes: 3 additions & 2 deletions packages/opentelemetry-web/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,11 @@ export function addSpanNetworkEvents(
addSpanNetworkEvent(span, PTN.REQUEST_START, resource);
addSpanNetworkEvent(span, PTN.RESPONSE_START, resource);
addSpanNetworkEvent(span, PTN.RESPONSE_END, resource);
if (resource[PTN.ENCODED_BODY_SIZE]) {
const contentLength = resource[PTN.ENCODED_BODY_SIZE];
if (contentLength !== undefined) {
span.setAttribute(
HttpAttribute.HTTP_RESPONSE_CONTENT_LENGTH,
resource[PTN.ENCODED_BODY_SIZE]
contentLength
);
}
}
Expand Down