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

feat(sdk-logs): make dropping attribute print message #4614

Merged
merged 7 commits into from
Apr 15, 2024
Merged

feat(sdk-logs): make dropping attribute print message #4614

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8bb16dc
feat(sdk-logs): make dropping attribute print message
HyunnoH Dec 13, 2023
f702bff
chore: update changelog
HyunnoH Apr 10, 2024
7369607
chore(sdk-logs): add comment to explain message logic
HyunnoH Apr 10, 2024
d8802b6
Merge branch 'main' into print-message-when-logrecord-attribute-dropped
pichlermarc Apr 11, 2024
f39a20f
Merge branch 'main' into print-message-when-logrecord-attribute-dropped
pichlermarc Apr 15, 2024
6fc5d64
Update experimental/CHANGELOG.md
pichlermarc Apr 15, 2024
3465464
Merge branch 'main' into print-message-when-logrecord-attribute-dropped
pichlermarc Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions experimental/packages/sdk-logs/src/LogRecord.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,9 @@ export class LogRecord implements ReadableLogRecord {
this._logRecordLimits.attributeCountLimit &&
!Object.prototype.hasOwnProperty.call(this.attributes, key)
) {
if (this.droppedAttributesCount === 1) {
HyunnoH marked this conversation as resolved.
Show resolved Hide resolved
api.diag.warn('Dropping extra attributes.');
}
return this;
}
if (isAttributeValue(value)) {
Expand Down
67 changes: 43 additions & 24 deletions experimental/packages/sdk-logs/test/common/LogRecord.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,32 +177,31 @@ describe('LogRecord', () => {

describe('when logRecordLimits options set', () => {
describe('when "attributeCountLimit" option defined', () => {
const { logRecord } = setup({ attributeCountLimit: 100 });
for (let i = 0; i < 150; i++) {
let attributeValue;
switch (i % 3) {
case 0: {
attributeValue = `bar${i}`;
break;
}
case 1: {
attributeValue = [`bar${i}`];
break;
}
case 2: {
attributeValue = {
bar: `bar${i}`,
};
break;
}
default: {
attributeValue = `bar${i}`;
it('should remove / drop all remaining values after the number of values exceeds this limit', () => {
const { logRecord } = setup({ attributeCountLimit: 100 });
for (let i = 0; i < 150; i++) {
let attributeValue;
switch (i % 3) {
case 0: {
attributeValue = `bar${i}`;
break;
}
case 1: {
attributeValue = [`bar${i}`];
break;
}
case 2: {
attributeValue = {
bar: `bar${i}`,
};
break;
}
default: {
attributeValue = `bar${i}`;
}
}
logRecord.setAttribute(`foo${i}`, attributeValue);
}
logRecord.setAttribute(`foo${i}`, attributeValue);
}

it('should remove / drop all remaining values after the number of values exceeds this limit', () => {
const { attributes, droppedAttributesCount } = logRecord;
assert.strictEqual(Object.keys(attributes).length, 100);
assert.strictEqual(attributes.foo0, 'bar0');
Expand All @@ -212,6 +211,26 @@ describe('LogRecord', () => {
assert.strictEqual(attributes.foo149, undefined);
assert.strictEqual(droppedAttributesCount, 50);
});

it('should not print message when there are no dropped attributes', () => {
const warnStub = sinon.spy(diag, 'warn');
const { logRecord } = setup({ attributeCountLimit: 10 });
for (let i = 0; i < 7; i++) {
logRecord.setAttribute(`foo${i}`, `bar${i}`);
}
sinon.assert.callCount(warnStub, 0);
warnStub.restore();
});

it('should print message only once when attribute(s) are dropped', () => {
const warnStub = sinon.spy(diag, 'warn');
const { logRecord } = setup({ attributeCountLimit: 5 });
for (let i = 0; i < 7; i++) {
logRecord.setAttribute(`foo${i}`, `bar${i}`);
}
sinon.assert.callCount(warnStub, 1);
warnStub.restore();
});
});

describe('when "attributeValueLengthLimit" option defined', () => {
Expand Down