loosen tag types

Author: lobsterkatie

MIGRATION.md

@@ -92,7 +92,7 @@ We realized how annoying it is to set a whole object using `setExtra`, that's wh
 `Scope`.
 
 ```typescript
-setTags(tags: { [key: string]: string }): this;
+setTags(tags: { [key: string]: string | number | boolean | undefined }): this;
 setExtras(extras: { [key: string]: any }): this;
 clearBreadcrumbs(): this;
 ```

packages/hub/src/hub.ts

@@ -261,7 +261,7 @@ export class Hub implements HubInterface {
   /**
    * @inheritDoc
    */
-  public setTags(tags: { [key: string]: string }): void {
+  public setTags(tags: { [key: string]: string | number | boolean | undefined }): void {
     const scope = this.getScope();
     if (scope) scope.setTags(tags);
   }
@@ -277,7 +277,7 @@ export class Hub implements HubInterface {
   /**
    * @inheritDoc
    */
-  public setTag(key: string, value: string): void {
+  public setTag(key: string, value: string | number | boolean | undefined): void {
     const scope = this.getScope();
     if (scope) scope.setTag(key, value);
   }

packages/hub/src/scope.ts

@@ -41,7 +41,7 @@ export class Scope implements ScopeInterface {
   protected _user: User = {};
 
   /** Tags */
-  protected _tags: { [key: string]: string } = {};
+  protected _tags: { [key: string]: string | number | boolean | undefined } = {};
 
   /** Extra */
   protected _extra: Extras = {};
@@ -124,7 +124,7 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritDoc
    */
-  public setTags(tags: { [key: string]: string }): this {
+  public setTags(tags: { [key: string]: string | number | boolean | undefined }): this {
     this._tags = {
       ...this._tags,
       ...tags,
@@ -136,7 +136,7 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritDoc
    */
-  public setTag(key: string, value: string): this {
+  public setTag(key: string, value: string | number | boolean | undefined): this {
     this._tags = { ...this._tags, [key]: value };
     this._notifyScopeListeners();
     return this;

packages/minimal/src/index.ts

@@ -127,7 +127,7 @@ export function setExtras(extras: Extras): void {
  * Set an object that will be merged sent as tags data with the event.
  * @param tags Tags context object to merge into current context.
  */
-export function setTags(tags: { [key: string]: string }): void {
+export function setTags(tags: { [key: string]: string | number | boolean | undefined }): void {
   callOnHub<void>('setTags', tags);
 }
 
@@ -142,10 +142,13 @@ export function setExtra(key: string, extra: Extra): void {
 
 /**
  * Set key:value that will be sent as tags data with the event.
+ *
+ * Can also be used to unset a tag, by passing `undefined`.
+ *
  * @param key String key of tag
- * @param value String value of tag
+ * @param value Value of tag
  */
-export function setTag(key: string, value: string): void {
+export function setTag(key: string, value: string | number | boolean | undefined): void {
   callOnHub<void>('setTag', key, value);
 }
 

packages/react/src/reactrouterv3.ts

@@ -62,7 +62,9 @@ export function reactRouterV3Instrumentation(
           if (activeTransaction) {
             activeTransaction.finish();
           }
-          const tags: Record<string, string> = { 'routing.instrumentation': 'react-router-v3' };
+          const tags: Record<string, string | number | boolean | undefined> = {
+            'routing.instrumentation': 'react-router-v3',
+          };
           if (prevName) {
             tags.from = prevName;
           }

packages/tracing/src/span.ts

@@ -86,7 +86,7 @@ export class Span implements SpanInterface {
   /**
    * @inheritDoc
    */
-  public tags: { [key: string]: string } = {};
+  public tags: { [key: string]: string | number | boolean | undefined } = {};
 
   /**
    * @inheritDoc
@@ -187,7 +187,7 @@ export class Span implements SpanInterface {
   /**
    * @inheritDoc
    */
-  public setTag(key: string, value: string): this {
+  public setTag(key: string, value: string | number | boolean | undefined): this {
     this.tags = { ...this.tags, [key]: value };
     return this;
   }
@@ -257,7 +257,7 @@ export class Span implements SpanInterface {
     parent_span_id?: string;
     span_id: string;
     status?: string;
-    tags?: { [key: string]: string };
+    tags?: { [key: string]: string | number | boolean | undefined };
     trace_id: string;
   } {
     return dropUndefinedKeys({
@@ -284,7 +284,7 @@ export class Span implements SpanInterface {
     span_id: string;
     start_timestamp: number;
     status?: string;
-    tags?: { [key: string]: string };
+    tags?: { [key: string]: string | number | boolean | undefined };
     timestamp?: number;
     trace_id: string;
   } {

packages/types/src/event.ts

@@ -35,7 +35,7 @@ export interface Event {
   stacktrace?: Stacktrace;
   breadcrumbs?: Breadcrumb[];
   contexts?: Contexts;
-  tags?: { [key: string]: string };
+  tags?: { [key: string]: string | number | boolean | undefined };
   extra?: Extras;
   user?: User;
   type?: EventType;

packages/types/src/hub.ts

@@ -124,16 +124,20 @@ export interface Hub {
 
   /**
    * Set an object that will be merged sent as tags data with the event.
+   *
    * @param tags Tags context object to merge into current context.
    */
-  setTags(tags: { [key: string]: string }): void;
+  setTags(tags: { [key: string]: string | number | boolean | undefined }): void;
 
   /**
    * Set key:value that will be sent as tags data with the event.
+   *
+   * Can also be used to unset a tag, by passing `undefined`.
+   *
    * @param key String key of tag
-   * @param value String value of tag
+   * @param value Value of tag
    */
-  setTag(key: string, value: string): void;
+  setTag(key: string, value: string | number | boolean | undefined): void;
 
   /**
    * Set key:value that will be sent as extra data with the event.

packages/types/src/scope.ts

@@ -17,7 +17,7 @@ export interface ScopeContext {
   level: Severity;
   extra: Extras;
   contexts: Contexts;
-  tags: { [key: string]: string };
+  tags: { [key: string]: string | number | boolean | undefined };
   fingerprint: string[];
 }
 
@@ -45,14 +45,17 @@ export interface Scope {
    * Set an object that will be merged sent as tags data with the event.
    * @param tags Tags context object to merge into current context.
    */
-  setTags(tags: { [key: string]: string }): this;
+  setTags(tags: { [key: string]: string | number | boolean | undefined }): this;
 
   /**
    * Set key:value that will be sent as tags data with the event.
+   *
+   * Can also be used to unset a tag by passing `undefined`.
+   *
    * @param key String key of tag
-   * @param value String value of tag
+   * @param value Value of tag
    */
-  setTag(key: string, value: string): this;
+  setTag(key: string, value: string | number | boolean | undefined): this;
 
   /**
    * Set an object that will be merged sent as extra data with the event.

packages/types/src/span.ts

@@ -41,7 +41,7 @@ export interface SpanContext {
   /**
    * Tags of the Span.
    */
-  tags?: { [key: string]: string };
+  tags?: { [key: string]: string | number | boolean | undefined };
 
   /**
    * Data of the Span.
@@ -79,7 +79,7 @@ export interface Span extends SpanContext {
   /**
    * @inheritDoc
    */
-  tags: { [key: string]: string };
+  tags: { [key: string]: string | number | boolean | undefined };
 
   /**
    * @inheritDoc
@@ -98,11 +98,14 @@ export interface Span extends SpanContext {
   finish(endTimestamp?: number): void;
 
   /**
-   * Sets the tag attribute on the current span
+   * Sets the tag attribute on the current span.
+   *
+   * Can also be used to unset a tag, by passing `undefined`.
+   *
    * @param key Tag key
    * @param value Tag value
    */
-  setTag(key: string, value: string): this;
+  setTag(key: string, value: string | number | boolean | undefined): this;
 
   /**
    * Sets the data attribute on the current span
@@ -156,7 +159,7 @@ export interface Span extends SpanContext {
     parent_span_id?: string;
     span_id: string;
     status?: string;
-    tags?: { [key: string]: string };
+    tags?: { [key: string]: string | number | boolean | undefined };
     trace_id: string;
   };
   /** Convert the object to JSON */
@@ -168,7 +171,7 @@ export interface Span extends SpanContext {
     span_id: string;
     start_timestamp: number;
     status?: string;
-    tags?: { [key: string]: string };
+    tags?: { [key: string]: string | number | boolean | undefined };
     timestamp?: number;
     trace_id: string;
   };