Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

docs: add notes on attribute key descriptor #155

Merged
merged 2 commits into from
Jan 25, 2022
Merged
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
2 changes: 2 additions & 0 deletions src/common/Attributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

/**
* Attributes is a map from string to attribute values.
*
* Note: only the own enumerable keys are counted as valid attribute keys.
*/
export interface Attributes {
[attributeKey: string]: AttributeValue | undefined;
Expand Down
4 changes: 2 additions & 2 deletions src/trace/attributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
import { Attributes, AttributeValue } from '../common/Attributes';

/**
* @deprecated please use Attributes
* @deprecated please use {@link Attributes}
*/
export type SpanAttributes = Attributes;

/**
* @deprecated please use AttributeValue
* @deprecated please use {@link AttributeValue}
*/
export type SpanAttributeValue = AttributeValue;