Skip to content

observability

Class info

Classes

Name Children Inherits
AgentOpsProviderConfig
llmling_agent.models.observability
Configuration for AgentOps provider.
    ArizePhoenixProviderConfig
    llmling_agent.models.observability
    Configuration for Arize Phoenix provider.
      BaseObservabilityProviderConfig
      llmling_agent.models.observability
      Base configuration for observability providers.
      BraintrustProviderConfig
      llmling_agent.models.observability
      Configuration for Braintrust provider.
        LangsmithProviderConfig
        llmling_agent.models.observability
        Configuration for Langsmith provider.
          LogfireProviderConfig
          llmling_agent.models.observability
          Configuration for Logfire provider.
            MlFlowProviderConfig
            llmling_agent.models.observability
            Configuration for MlFlow provider.
              ObservabilityConfig
              llmling_agent.models.observability
              Global observability configuration.
                TraceloopProviderConfig
                llmling_agent.models.observability
                Configuration for Traceloop provider.

                  🛈 DocStrings

                  Configuration models for observability providers.

                  AgentOpsProviderConfig

                  Bases: BaseObservabilityProviderConfig

                  Configuration for AgentOps provider.

                  Source code in src/llmling_agent/models/observability.py 
                  48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
                  class AgentOpsProviderConfig(BaseObservabilityProviderConfig):
    """Configuration for AgentOps provider."""

    type: Literal["agentops"] = Field("agentops", init=False)

    api_key: SecretStr | None = None
    """AgentOps API key."""

    parent_key: str | None = None
    """Parent key for session inheritance."""

    endpoint: str | None = None
    """Custom endpoint URL for AgentOps service."""

    max_wait_time: int | None = None
    """Maximum time to wait for batch processing in seconds."""

    max_queue_size: int | None = None
    """Maximum size of the event queue."""

    tags: list[str] | None = None
    """Tags to apply to all events in this session."""

    instrument_llm_calls: bool | None = None
    """Whether to automatically instrument LLM API calls."""

    auto_start_session: bool | None = None
    """Whether to automatically start a session on initialization."""

    inherited_session_id: str | None = None
    """Session ID to inherit from."""

    skip_auto_end_session: bool | None = None
    """Whether to skip auto-ending the session on exit."""

    def get_provider(self) -> ObservabilityProvider:
        """Get the provider instance."""
        from llmling_agent_observability.agentops_provider import AgentOpsProvider

        return AgentOpsProvider(self)

                  api_key class-attribute instance-attribute 

                  api_key: SecretStr | None = None

                  AgentOps API key.

                  auto_start_session class-attribute instance-attribute 

                  auto_start_session: bool | None = None

                  Whether to automatically start a session on initialization.

                  endpoint class-attribute instance-attribute 

                  endpoint: str | None = None

                  Custom endpoint URL for AgentOps service.

                  inherited_session_id class-attribute instance-attribute 

                  inherited_session_id: str | None = None

                  Session ID to inherit from.

                  instrument_llm_calls class-attribute instance-attribute 

                  instrument_llm_calls: bool | None = None

                  Whether to automatically instrument LLM API calls.

                  max_queue_size class-attribute instance-attribute 

                  max_queue_size: int | None = None

                  Maximum size of the event queue.

                  max_wait_time class-attribute instance-attribute 

                  max_wait_time: int | None = None

                  Maximum time to wait for batch processing in seconds.

                  parent_key class-attribute instance-attribute 

                  parent_key: str | None = None

                  Parent key for session inheritance.

                  skip_auto_end_session class-attribute instance-attribute 

                  skip_auto_end_session: bool | None = None

                  Whether to skip auto-ending the session on exit.

                  tags class-attribute instance-attribute 

                  tags: list[str] | None = None

                  Tags to apply to all events in this session.

                  get_provider 

                  get_provider() -> ObservabilityProvider

                  Get the provider instance.

                  Source code in src/llmling_agent/models/observability.py 
                  83
84
85
86
87
                  def get_provider(self) -> ObservabilityProvider:
    """Get the provider instance."""
    from llmling_agent_observability.agentops_provider import AgentOpsProvider

    return AgentOpsProvider(self)

                  ArizePhoenixProviderConfig

                  Bases: BaseObservabilityProviderConfig

                  Configuration for Arize Phoenix provider.

                  Source code in src/llmling_agent/models/observability.py 
                  114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
                  class ArizePhoenixProviderConfig(BaseObservabilityProviderConfig):
    """Configuration for Arize Phoenix provider."""

    type: Literal["arize"] = Field("arize", init=False)

    api_key: SecretStr | None = None
    """Arize API key."""

    space_key: str | None = None
    """Arize workspace identifier."""

    model_id: str | None = None
    """Model identifier in Arize."""

    environment: str | None = None
    """Environment name."""

    def get_provider(self) -> ObservabilityProvider:
        """Get the provider instance."""
        from llmling_agent_observability.arize_provider import ArizePhoenixProvider

        return ArizePhoenixProvider(self)

                  api_key class-attribute instance-attribute 

                  api_key: SecretStr | None = None

                  Arize API key.

                  environment class-attribute instance-attribute 

                  environment: str | None = None

                  Environment name.

                  model_id class-attribute instance-attribute 

                  model_id: str | None = None

                  Model identifier in Arize.

                  space_key class-attribute instance-attribute 

                  space_key: str | None = None

                  Arize workspace identifier.

                  get_provider 

                  get_provider() -> ObservabilityProvider

                  Get the provider instance.

                  Source code in src/llmling_agent/models/observability.py 
                  131
132
133
134
135
                  def get_provider(self) -> ObservabilityProvider:
    """Get the provider instance."""
    from llmling_agent_observability.arize_provider import ArizePhoenixProvider

    return ArizePhoenixProvider(self)

                  BaseObservabilityProviderConfig

                  Bases: BaseModel

                  Base configuration for observability providers.

                  Source code in src/llmling_agent/models/observability.py 
                  14
15
16
17
18
19
20
21
22
23
24
                  class BaseObservabilityProviderConfig(BaseModel):
    """Base configuration for observability providers."""

    type: str = Field(init=True)
    """Observability provider."""

    model_config = ConfigDict(frozen=True, use_attribute_docstrings=True, extra="forbid")

    def get_provider(self) -> ObservabilityProvider:
        """Get the provider instance."""
        raise NotImplementedError

                  type class-attribute instance-attribute 

                  type: str = Field(init=True)

                  Observability provider.

                  get_provider 

                  get_provider() -> ObservabilityProvider

                  Get the provider instance.

                  Source code in src/llmling_agent/models/observability.py 
                  22
23
24
                  def get_provider(self) -> ObservabilityProvider:
    """Get the provider instance."""
    raise NotImplementedError

                  BraintrustProviderConfig

                  Bases: BaseObservabilityProviderConfig

                  Configuration for Braintrust provider.

                  Source code in src/llmling_agent/models/observability.py 
                  153
154
155
156
157
158
159
160
161
162
163
164
165
                  class BraintrustProviderConfig(BaseObservabilityProviderConfig):
    """Configuration for Braintrust provider."""

    type: Literal["braintrust"] = Field("braintrust", init=False)

    api_key: SecretStr | None = None
    """Braintrust API key."""

    def get_provider(self) -> ObservabilityProvider:
        """Get the provider instance."""
        from llmling_agent_observability.braintrust_provider import BraintrustProvider

        return BraintrustProvider(self)

                  api_key class-attribute instance-attribute 

                  api_key: SecretStr | None = None

                  Braintrust API key.

                  get_provider 

                  get_provider() -> ObservabilityProvider

                  Get the provider instance.

                  Source code in src/llmling_agent/models/observability.py 
                  161
162
163
164
165
                  def get_provider(self) -> ObservabilityProvider:
    """Get the provider instance."""
    from llmling_agent_observability.braintrust_provider import BraintrustProvider

    return BraintrustProvider(self)

                  LangsmithProviderConfig

                  Bases: BaseObservabilityProviderConfig

                  Configuration for Langsmith provider.

                  Source code in src/llmling_agent/models/observability.py 
                   90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
                  class LangsmithProviderConfig(BaseObservabilityProviderConfig):
    """Configuration for Langsmith provider."""

    type: Literal["langsmith"] = Field("langsmith", init=False)

    api_key: SecretStr | None = None
    """Langsmith API key."""

    project_name: str | None = None
    """Project name in Langsmith."""

    tags: list[str] = Field(default_factory=list)
    """Tags to apply to traces."""

    environment: str | None = None
    """Environment name (dev/prod/staging)."""

    def get_provider(self) -> ObservabilityProvider:
        """Get the provider instance."""
        from llmling_agent_observability.langsmith_provider import LangsmithProvider

        return LangsmithProvider(self)

                  api_key class-attribute instance-attribute 

                  api_key: SecretStr | None = None

                  Langsmith API key.

                  environment class-attribute instance-attribute 

                  environment: str | None = None

                  Environment name (dev/prod/staging).

                  project_name class-attribute instance-attribute 

                  project_name: str | None = None

                  Project name in Langsmith.

                  tags class-attribute instance-attribute 

                  tags: list[str] = Field(default_factory=list)

                  Tags to apply to traces.

                  get_provider 

                  get_provider() -> ObservabilityProvider

                  Get the provider instance.

                  Source code in src/llmling_agent/models/observability.py 
                  107
108
109
110
111
                  def get_provider(self) -> ObservabilityProvider:
    """Get the provider instance."""
    from llmling_agent_observability.langsmith_provider import LangsmithProvider

    return LangsmithProvider(self)

                  LogfireProviderConfig

                  Bases: BaseObservabilityProviderConfig

                  Configuration for Logfire provider.

                  Source code in src/llmling_agent/models/observability.py 
                  27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
                  class LogfireProviderConfig(BaseObservabilityProviderConfig):
    """Configuration for Logfire provider."""

    type: Literal["logfire"] = Field("logfire", init=False)

    token: SecretStr | None = None
    """Logfire API token."""

    service_name: str | None = None
    """Service name for tracing."""

    environment: str | None = None
    """Environment name (dev/prod/etc)."""

    def get_provider(self) -> ObservabilityProvider:
        """Get the provider instance."""
        from llmling_agent_observability.logfire_provider import LogfireProvider

        return LogfireProvider(self)

                  environment class-attribute instance-attribute 

                  environment: str | None = None

                  Environment name (dev/prod/etc).

                  service_name class-attribute instance-attribute 

                  service_name: str | None = None

                  Service name for tracing.

                  token class-attribute instance-attribute 

                  token: SecretStr | None = None

                  Logfire API token.

                  get_provider 

                  get_provider() -> ObservabilityProvider

                  Get the provider instance.

                  Source code in src/llmling_agent/models/observability.py 
                  41
42
43
44
45
                  def get_provider(self) -> ObservabilityProvider:
    """Get the provider instance."""
    from llmling_agent_observability.logfire_provider import LogfireProvider

    return LogfireProvider(self)

                  MlFlowProviderConfig

                  Bases: BaseObservabilityProviderConfig

                  Configuration for MlFlow provider.

                  Source code in src/llmling_agent/models/observability.py 
                  138
139
140
141
142
143
144
145
146
147
148
149
150
                  class MlFlowProviderConfig(BaseObservabilityProviderConfig):
    """Configuration for MlFlow provider."""

    type: Literal["mlflow"] = Field("mlflow", init=False)

    tracking_uri: str | None = None
    """Tracking URI for MLFlow."""

    def get_provider(self) -> ObservabilityProvider:
        """Get the provider instance."""
        from llmling_agent_observability.mlflow_provider import MlFlowProvider

        return MlFlowProvider(self)

                  tracking_uri class-attribute instance-attribute 

                  tracking_uri: str | None = None

                  Tracking URI for MLFlow.

                  get_provider 

                  get_provider() -> ObservabilityProvider

                  Get the provider instance.

                  Source code in src/llmling_agent/models/observability.py 
                  146
147
148
149
150
                  def get_provider(self) -> ObservabilityProvider:
    """Get the provider instance."""
    from llmling_agent_observability.mlflow_provider import MlFlowProvider

    return MlFlowProvider(self)

                  ObservabilityConfig

                  Bases: BaseModel

                  Global observability configuration.

                  Source code in src/llmling_agent/models/observability.py 
                  195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
                  class ObservabilityConfig(BaseModel):
    """Global observability configuration."""

    enabled: bool = True
    """Whether observability is enabled."""

    providers: list[ObservabilityProviderConfig] = Field(default_factory=list)
    """Provider-specific configuration."""

    instrument_libraries: list[str] | None = None
    """Which providers should be imported before initialization.

    By default, all libraries used in the AgentsManifest are instrumented.
    """

    model_config = ConfigDict(use_attribute_docstrings=True, extra="forbid")

                  enabled class-attribute instance-attribute 

                  enabled: bool = True

                  Whether observability is enabled.

                  instrument_libraries class-attribute instance-attribute 

                  instrument_libraries: list[str] | None = None

                  Which providers should be imported before initialization.

                  By default, all libraries used in the AgentsManifest are instrumented.

                  providers class-attribute instance-attribute 

                  providers: list[ObservabilityProviderConfig] = Field(default_factory=list)

                  Provider-specific configuration.

                  TraceloopProviderConfig

                  Bases: BaseObservabilityProviderConfig

                  Configuration for Traceloop provider.

                  Source code in src/llmling_agent/models/observability.py 
                  168
169
170
171
172
173
174
175
176
177
178
179
180
                  class TraceloopProviderConfig(BaseObservabilityProviderConfig):
    """Configuration for Traceloop provider."""

    type: Literal["traceloop"] = Field("traceloop", init=False)

    api_key: SecretStr | None = None
    """Traceloop API key."""

    def get_provider(self) -> ObservabilityProvider:
        """Get the provider instance."""
        from llmling_agent_observability.traceloop_provider import TraceloopProvider

        return TraceloopProvider(self)

                  api_key class-attribute instance-attribute 

                  api_key: SecretStr | None = None

                  Traceloop API key.

                  get_provider 

                  get_provider() -> ObservabilityProvider

                  Get the provider instance.

                  Source code in src/llmling_agent/models/observability.py 
                  176
177
178
179
180
                  def get_provider(self) -> ObservabilityProvider:
    """Get the provider instance."""
    from llmling_agent_observability.traceloop_provider import TraceloopProvider

    return TraceloopProvider(self)