More specific api type names (open-telemetry#1874)

Author: dyladan

api/README.md

@@ -133,7 +133,7 @@ async function doSomething() {
   } catch (err) {
     span.setStatus({
       // use an appropriate status code here
-      code: api.StatusCode.ERROR,
+      code: api.SpanStatusCode.ERROR,
       message: err.message,
     });
     span.end();

api/packages/opentelemetry-api/package-lock.json

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { EntryValue } from './EntryValue';
+import { BaggageEntryValue } from './EntryValue';
 
 /**
  * Baggage represents collection of entries. Each key of
@@ -25,5 +25,5 @@ import { EntryValue } from './EntryValue';
  * dimension to the metric or additional contest properties to logs and traces.
  */
 export interface Baggage {
-  [entryKey: string]: EntryValue;
+  [entryKey: string]: BaggageEntryValue;
 }

api/packages/opentelemetry-context-base/package-lock.json

@@ -13,22 +13,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export interface EntryValue {
-  /** `String` value of the `EntryValue`. */
+export interface BaggageEntryValue {
+  /** `String` value of the `BaggageEntryValue`. */
   value: string;
   /**
    * ttl is an integer that represents number of hops an entry can
    * propagate.
    */
-  ttl?: EntryTtl;
+  ttl?: BaggageEntryTtl;
 }
 
 /**
- * EntryTtl is an integer that represents number of hops an entry can propagate.
+ * BaggageEntryTtl is an integer that represents number of hops an entry can propagate.
  *
  * For now, ONLY special values (0 and -1) are supported.
  */
-export enum EntryTtl {
+export enum BaggageEntryTtl {
   /**
    * NO_PROPAGATION is considered to have local context and is used within the
    * process it created.

api/src/baggage/Baggage.ts

@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-import { Attributes } from './attributes';
+import { SpanAttributes } from './attributes';
 
 /** A text annotation with a set of attributes. */
 export interface Event {
   /** The name of the event. */
   name: string;
   /** The attributes of the event. */
-  attributes?: Attributes;
+  attributes?: SpanAttributes;
 }

api/src/baggage/EntryValue.ts

@@ -16,10 +16,10 @@
 
 import { Exception } from '../common/Exception';
 import { TimeInput } from '../common/Time';
-import { Attributes } from './attributes';
+import { SpanAttributes } from './attributes';
 import { Span } from './span';
 import { SpanContext } from './span_context';
-import { Status } from './status';
+import { SpanStatus } from './status';
 import { INVALID_SPAN_CONTEXT } from './spancontext-utils';
 
 /**
@@ -43,17 +43,17 @@ export class NoopSpan implements Span {
   }
 
   // By default does nothing
-  setAttributes(_attributes: Attributes): this {
+  setAttributes(_attributes: SpanAttributes): this {
     return this;
   }
 
   // By default does nothing
-  addEvent(_name: string, _attributes?: Attributes): this {
+  addEvent(_name: string, _attributes?: SpanAttributes): this {
     return this;
   }
 
   // By default does nothing
-  setStatus(_status: Status): this {
+  setStatus(_status: SpanStatus): this {
     return this;
   }
 

api/src/trace/Event.ts

@@ -15,7 +15,7 @@
  */
 
 import { Context } from '@opentelemetry/context-base';
-import { Attributes } from './attributes';
+import { SpanAttributes } from './attributes';
 import { Link } from './link';
 import { SamplingResult } from './SamplingResult';
 import { SpanKind } from './span_kind';
@@ -35,7 +35,7 @@ export interface Sampler {
    *     span to be created starts a new trace.
    * @param spanName of the span to be created.
    * @param spanKind of the span to be created.
-   * @param attributes Initial set of Attributes for the Span being constructed.
+   * @param attributes Initial set of SpanAttributes for the Span being constructed.
    * @param links Collection of links that will be associated with the Span to
    *     be created. Typically useful for batch operations.
    * @returns a {@link SamplingResult}.
@@ -45,7 +45,7 @@ export interface Sampler {
     traceId: string,
     spanName: string,
     spanKind: SpanKind,
-    attributes: Attributes,
+    attributes: SpanAttributes,
     links: Link[]
   ): SamplingResult;
 

api/src/trace/NoopSpan.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Attributes } from './attributes';
+import { SpanAttributes } from './attributes';
 
 /**
  * A sampling decision that determines how a {@link Span} will be recorded
@@ -52,5 +52,5 @@ export interface SamplingResult {
    * Caller may call {@link Sampler}.shouldSample any number of times and
    * can safely cache the returned value.
    */
-  attributes?: Readonly<Attributes>;
+  attributes?: Readonly<SpanAttributes>;
 }

api/src/trace/Sampler.ts

@@ -15,7 +15,7 @@
  */
 
 import { TimeInput } from '../common/Time';
-import { Attributes } from './attributes';
+import { SpanAttributes } from './attributes';
 import { Link } from './link';
 import { SpanKind } from './span_kind';
 
@@ -30,7 +30,7 @@ export interface SpanOptions {
   kind?: SpanKind;
 
   /** A span's attributes */
-  attributes?: Attributes;
+  attributes?: SpanAttributes;
 
   /** {@link Link}s span to other spans */
   links?: Link[];