# `Otel.InstrumentationScope`
[🔗](https://github.com/yangbancode/otel/blob/main/lib/otel/instrumentation_scope.ex#L1)

Identity of the code that produced telemetry (spec
`common/instrumentation-scope.md`, Status: **Stable**).

The spec defines the scope as a `(name, version, schema_url,
attributes)` tuple that "SHOULD uniquely identify the
logical unit of software that emits the telemetry." In a
full plugin ecosystem this would be `opentelemetry_phoenix`,
`opentelemetry_ecto`, etc. — different identities for each
instrumentation library.

## Hardcoded to the SDK identity (minikube)

This project ships no plugin ecosystem. All telemetry is
emitted directly through the SDK's API, so all spans / log
records / metrics share the same instrumentation scope:
the SDK itself.

Defaults are read from `mix.exs` via `Mix.Project.config/0`
at compile time and stored in module attributes
(`@name`, `@version`). `new/1` is the canonical
constructor — the `defstruct` declares only the field
names so all initialization flows through `new/1`.

## Usage

    Otel.InstrumentationScope.new()
    # => %Otel.InstrumentationScope{
    #      name: "otel",
    #      version: "0.2.0",
    #      schema_url: "",
    #      attributes: %{}
    #    }

    Otel.InstrumentationScope.new(%{schema_url: "https://example.com"})

## References

- OTel Instrumentation Scope: `opentelemetry-specification/specification/common/instrumentation-scope.md`
- `attributes` field origin: OTEP `0201-scope-attributes.md` (added in spec v1.13.0)

# `primitive`

```elixir
@type primitive() ::
  String.t() | {:bytes, binary()} | boolean() | integer() | float() | nil
```

# `primitive_any`

```elixir
@type primitive_any() ::
  primitive() | [primitive_any()] | %{required(String.t()) => primitive_any()}
```

# `t`

```elixir
@type t() :: %Otel.InstrumentationScope{
  attributes: %{required(String.t()) => primitive_any()},
  name: String.t(),
  schema_url: String.t(),
  version: String.t()
}
```

An instrumentation scope tuple (spec `common/instrumentation-scope.md`).

Fields:

- `name` — identity of the emitting software unit. Hardcoded
  to the SDK app name (`"otel"`) per minikube scope.
- `version` — version of the emitting software unit.
  Hardcoded to the SDK version (e.g. `"0.2.0"`).
- `schema_url` — Optional. SHOULD identify the Telemetry
  Schema the scope's emitted telemetry conforms to. Empty
  string when unspecified.
- `attributes` — Optional. Additional scope-identifying
  key/value pairs (OTEP 0201, added in spec v1.13.0). Values
  follow OTel attribute rules: primitives and homogeneous
  arrays only, no maps and no heterogeneous arrays. Empty
  map when unspecified.

# `new`

```elixir
@spec new(opts :: map()) :: t()
```

**SDK** — Construct an instrumentation scope. Caller may
override any field via `opts`.

---

*Consult [api-reference.md](api-reference.md) for complete listing*