OpenObserve

https://openobserve.ai/docs/
Admin
OpenObserve is a full-stack observability platform offering log management, metric monitoring,...
Tokens:630,242
Snippets:5,406
Trust Score:8.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies with uv pip

Source: https://openobserve.ai/docs/integration/ai/llm-applications

Installs the required Python packages for the quickstart example, including the OpenObserve telemetry SDK, OpenAI, OpenTelemetry instrumentation, and dotenv. Also installs dependencies from requirements.txt.

```shell
uv pip install openobserve-telemetry-sdk openai opentelemetry-instrumentation-openai python-dotenv
uv pip install -r requirements.txt
```

--------------------------------

### kubectl-Style Command Examples

Source: https://openobserve.ai/docs/administration/configuration/o2-cli/o2-cli

Example commands using the verb-first syntax for listing, getting, creating, updating, and deleting resources.

```bash
o2 list template
o2 get dashboard 123456
o2 create template -f template.yaml
o2 update pipeline -f pipeline.yaml
o2 delete function my-function
```

--------------------------------

### Resource-First Command Examples

Source: https://openobserve.ai/docs/administration/configuration/o2-cli/o2-cli

Example commands using the resource-first syntax for listing, getting, creating, updating, and deleting resources.

```bash
o2 template list
o2 dashboard get 123456
o2 template create -f template.yaml
o2 pipeline update -f pipeline.yaml
o2 function delete my-function
```

--------------------------------

### Verify prerequisites

Source: https://openobserve.ai/docs/enterprise-setup/amazon-eks

Checks that AWS CLI, eksctl, kubectl, helm, and yq are installed and configured. Run before starting the setup.

```bash
aws sts get-caller-identity      # returns your account + ARN
aws configure get region         # set this to the region you want the cluster in
eksctl version                   # ≥ 0.220
kubectl version --client
helm version
yq --version                     # must be v4.x
```

--------------------------------

### Install dependencies and run the Node.js service

Source: https://openobserve.ai/docs/ingestion/traces/nodejs

Commands to install dependencies and start the Node.js application with automatic tracing enabled.

```bash
npm install
```

```bash
node --require './tracing.js' app.js
```

--------------------------------

### React Native Setup (Beta)

Source: https://openobserve.ai/docs/user-guide/data-exploration/rum/setup

Installation and initialization of OpenObserve SDK for React Native, including navigation tracking and session replay.

```APIDOC
## React Native Setup (Beta)

### Description
Installation and initialization of OpenObserve SDK for React Native, including navigation tracking and session replay.

### Installation

#### npm
```bash
npm install @openobserve/mobile-react-native @openobserve/mobile-react-native-session-replay
```

#### yarn
```bash
yarn add @openobserve/mobile-react-native @openobserve/mobile-react-native-session-replay
```

#### iOS Pods
```bash
npx pod-install
```

### Initialization

#### OpenObserveProviderConfiguration

Builds the configuration for the OpenObserve SDK.

##### Constructor Parameters
- **clientToken** (string) - Required - The client token for authentication.
- **env** (string) - Required - The environment name (e.g., 'production').
- **trackingConsent** (TrackingConsent) - Required - The tracking consent level.
- **options** (object) - Optional - Additional configuration options.
  - **rumConfiguration** (object) - Optional - RUM configuration.
    - **applicationId** (string) - Required - The application ID.
    - **customEndpoint** (string) - Optional - Custom endpoint URL. The SDK appends `/rum` to this base URL.
    - **trackInteractions** (boolean) - Optional - Whether to track user interactions.
    - **trackResources** (boolean) - Optional - Whether to track resources.
    - **trackErrors** (boolean) - Optional - Whether to track errors.
  - **logsConfiguration** (object) - Optional - Logs configuration.
    - **customEndpoint** (string) - Optional - Custom endpoint URL. The SDK appends `/logs` to this base URL.

##### Properties
- **service** (string) - Optional - The service name.

#### OpenObserveProvider

Wraps the app tree and initializes the SDK.

##### Props
- **configuration** (OpenObserveProviderConfiguration) - Required - The configuration object.

### Navigation Tracking

#### O2RumReactNavigationTracking.startTrackingViews

Starts tracking screen views automatically with React Navigation.

##### Parameters
- **navigationRef** (object) - Required - The navigation reference.

#### O2Rum.startView

Starts recording a view manually.

#### O2Rum.stopView

Stops recording a view manually.

### Session Replay

#### SessionReplay.enable

Enables session replay.

##### Parameters
- **options** (object) - Required - Configuration options.
  - **replaySampleRate** (number) - Required - The sample rate for replay recording (0-100).
  - **startRecordingImmediately** (boolean) - Required - Whether to start recording immediately.
  - **customEndpoint** (string) - Required - Custom endpoint URL. The SDK appends `/replay` to this base URL as of version 0.1.2.

### Examples

#### Initialize SDK
```javascript
import {
  OpenObserveProvider,
  OpenObserveProviderConfiguration,
  TrackingConsent,
} from '@openobserve/mobile-react-native';

const OPENOBSERVE_ENDPOINT = 'https://your-instance.example.com/rum/v1/default';

const config = new OpenObserveProviderConfiguration(
  'your-client-token-here', // clientToken
  'production',             // env
  TrackingConsent.GRANTED,
  {
    rumConfiguration: {
      applicationId: 'my-react-native-app',
      customEndpoint: OPENOBSERVE_ENDPOINT,
      trackInteractions: true,
      trackResources: true,
      trackErrors: true,
    },
    logsConfiguration: {
      customEndpoint: OPENOBSERVE_ENDPOINT,
    },
  },
);
config.service = 'my-react-native-app';

export default function App() {
  return (
    <OpenObserveProvider configuration={config}>
      {/* your navigation container and app tree */}
    </OpenObserveProvider>
  );
}
```

#### Navigation Tracking
```javascript
import { O2RumReactNavigationTracking } from '@openobserve/mobile-react-navigation';

<NavigationContainer
  ref={navigationRef}
  onReady={() => {
    O2RumReactNavigationTracking.startTrackingViews(navigationRef.current);
  }}
>
  {/* your screens */}
</NavigationContainer>
```

#### Session Replay
```javascript
import { SessionReplay } from '@openobserve/mobile-react-native-session-replay';

SessionReplay.enable({
  replaySampleRate: 20,
  startRecordingImmediately: true,
  customEndpoint: OPENOBSERVE_ENDPOINT,
}).catch(() => {});
```
```

--------------------------------

### Install dependencies and start TypeScript server

Source: https://openobserve.ai/docs/ingestion/traces/typescript

Install npm dependencies and start the server using ts-node with the tracing.ts file. The server runs on port 8080; refresh the page multiple times to generate more traces.

```bash
npm install
ts-node --require './tracing.ts' app.ts

```

--------------------------------

### RUM Implementation Documentation Example

Source: https://openobserve.ai/docs/user-guide/data-exploration/rum/best-practices

Document your RUM implementation with this guide, which lists global context properties, custom actions, custom timings, and view name formats. Use it as a reference for your team.

```javascript
/**
 * RUM Implementation Guide
 *
 * Global Context:
 * - user_tier: string - User subscription tier (free, paid, enterprise)
 * - feature_flags: object - Active feature flags
 * - deployment_version: string - Current deployment version
 *
 * Custom Actions:
 * - purchase_completed: Fired when order is placed
 * - feature_used: Fired when user uses a key feature
 * - export_started: Fired when user exports data
 *
 * Custom Timings:
 * - dashboard_load_time: Time to load dashboard
 * - report_generation_time: Time to generate report
 *
 * View Names:
 * - Format: Section/Page
 * - Examples: Dashboard/Analytics, Product/Details
 */
```

--------------------------------

### Clone sample tracing repository

Source: https://openobserve.ai/docs/ingestion/traces/go

Clone the sample-tracing-golang repository to get started with the OpenTelemetry Go tracing setup.

```bash
git clone https://github.com/openobserve/sample-tracing-golang

```

--------------------------------

### Deploy AgentCore agent with OTLP environment variables

Source: https://openobserve.ai/docs/integration/ai/frameworks/amazon-bedrock-agentcore

Install the starter toolkit, configure the entrypoint, and launch the agent with environment variables to export traces to OpenObserve. The exporter appends /v1/traces automatically, so set the endpoint without the path suffix. Replace your_org_id and your_base64_token with your OpenObserve credentials.

```shell
pip install bedrock-agentcore-starter-toolkit

agentcore configure --entrypoint agent.py

agentcore launch \
  --env DISABLE_ADOT_OBSERVABILITY=true \
  --env OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \
  --env OTEL_EXPORTER_OTLP_ENDPOINT=https://api.openobserve.ai/api/your_org_id \
  --env "OTEL_EXPORTER_OTLP_HEADERS=Authorization=Basic <your_base64_token>" \
  --env OTEL_SERVICE_NAME=bedrock-agentcore-agent
```

--------------------------------

### Run OpenObserve SDK example scripts

Source: https://openobserve.ai/docs/user-guide/data-processing/opentelemetry/openobserve-python-sdk

Run the provided example scripts for traces, logs, metrics, and LangChain session tracking. Ensure environment variables are set before running. See the examples/ directory for more samples including LangChain RAG chains and user tracking patterns.

```bash
# Traces with OpenAI
python examples/openai_example.py

# Logs with standard Python logging
python examples/logs_example.py

# Metrics (counters, histograms, up/down counters)
python examples/metrics_example.py

# LangChain Q&A with session tracking
python examples/session_demo.py
```

--------------------------------

### Run the bundled OpenAI example

Source: https://openobserve.ai/docs/integration/ai/llm-applications

Runs the example script from the SDK repository to generate LLM traces. After running, open the OpenObserve dashboard to view the spans.

```shell
uv run examples/openai_example.py
```

--------------------------------

### Example configuration file

Source: https://openobserve.ai/docs/administration/configuration/o2-cli/o2-cli

Shows the structure of the ~/.o2/config.yaml file with profiles for default, dev, and prod environments.

```yaml
profiles:
  default:
    endpoint: https://openobserve.company.com
    organization: default
    username: user@company.com
    password: your-password
  dev:
    endpoint: https://dev.openobserve.com
    organization: dev-org
    username: dev-user@company.com
    password: dev-password
  prod:
    endpoint: https://prod.openobserve.com
    organization: prod-org
    username: prod-user@company.com
    password: prod-password
```

--------------------------------

### Install OpenObserve telemetry and vLLM dependencies

Source: https://openobserve.ai/docs/integration/ai/providers/vllm

Install the required Python packages for OpenObserve telemetry, OpenInference OpenAI instrumentation, and the OpenAI client. Then install vLLM and start a local server with a model of your choice.

```shell
pip install openobserve-telemetry-sdk openinference-instrumentation-openai openai python-dotenv
```

```shell
pip install vllm
vllm serve facebook/opt-125m --port 8001
```

--------------------------------

### Run Go server

Source: https://openobserve.ai/docs/ingestion/traces/go

Start the Go server after following the sample-tracing-golang readme steps. The server runs on http://localhost:8080/.

```bash
go run .

```

--------------------------------

### Deploy sample resources (alert, pipeline, function)

Source: https://openobserve.ai/docs/administration/configuration/o2-k8s-operator/o2-operator-overview

Deploys sample resources from the samples/ directory. The samples have different configRef requirements; most reference 'openobserve-main', but alert9-minimal.template.yaml references 'openobserve-config'.

```bash
# Deploy a minimal alert
kubectl apply -f samples/alerts/alert9-minimal.template.yaml

# Deploy a simple pipeline
kubectl apply -f samples/pipelines/srctodest.yaml

# Deploy a basic function
kubectl apply -f samples/functions/basic-function.yaml
```

--------------------------------

### React Native: install packages with npm

Source: https://openobserve.ai/docs/user-guide/rum

Install the OpenObserve React Native SDK and session replay packages using npm. This is the first step in the React Native setup.

```bash
npm install @openobserve/mobile-react-native @openobserve/mobile-react-native-session-replay
```

--------------------------------

### Get View Context with openobserveRum.getViewContext

Source: https://openobserve.ai/docs/user-guide/data-exploration/rum/advanced-features

Retrieves the current view context. The example logs the context object to the console.

```javascript
const viewContext = openobserveRum.getViewContext();
console.log(viewContext);
```

--------------------------------

### Initialize New Database

Source: https://openobserve.ai/docs/migration/migrate-database

Initialize the new database using the `init-db` command. The example uses PostgreSQL; adjust the `ZO_META_STORE` variable for MySQL.

```shell
ZO_META_STORE=postgres ./openobserve init-db

```

--------------------------------

### List Users Response Example

Source: https://openobserve.ai/docs/reference/api/user/list

Example JSON response returned by the GET /api/{organization}/users endpoint. It contains a list of user objects with fields email, first_name, last_name, and role. The role field supports values 'admin' or 'user'.

```json
{
	"list": [
		{
			"email": "admin@openobserve.ai",
			"fist_name": "ming",
			"last_name": "xing",
			"role": "admin"
		}
	]
}
```

--------------------------------

### Start OpenObserve

Source: https://openobserve.ai/docs/administration/maintenance/operator-guide/systemd

Starts the OpenObserve service using systemctl.

```shell
systemctl start openobserve
```

--------------------------------

### Get Global Context with openobserveRum.getGlobalContext

Source: https://openobserve.ai/docs/user-guide/data-exploration/rum/advanced-features

Retrieves the current global context object. The example logs the context and shows a sample output with the expected structure.

```javascript
const context = openobserveRum.getGlobalContext();
console.log(context);
// {
//   environment: 'production',
//   deployment_version: 'v2.5.1',
//   subscription_plan: 'premium',
//   ...
// }
```

--------------------------------

### Symlink gke-gcloud-auth-plugin on Homebrew

Source: https://openobserve.ai/docs/enterprise-setup/google-gke

Symlinks the gke-gcloud-auth-plugin binary to a directory on PATH for Homebrew installs. Fixes `kubectl get nodes` failing with `executable gke-gcloud-auth-plugin not found`.

```sh
ln -s /opt/homebrew/share/google-cloud-sdk/bin/gke-gcloud-auth-plugin \
      /opt/homebrew/bin/gke-gcloud-auth-plugin
```

--------------------------------

### List all subcommands with --help

Source: https://openobserve.ai/docs/administration/maintenance/operator-guide/cli-commands

Use `--help` to list all available subcommands of the OpenObserve binary.

```bash
./openobserve --help
```

--------------------------------

### Example cached file path structure

Source: https://openobserve.ai/docs/user-guide/account-administration/management/aggregation-cache

Shows the directory structure and file naming convention for a cached aggregation partition, reflecting the start and end timestamps of the partition.

```plaintext
/data/openobserve/cache/aggregations/default/logs/oly/
    13018130667245808899_30/
        1756116000000000_1756117800000000.arrow
```

--------------------------------

### Install openobserve-telemetry-sdk via pip

Source: https://openobserve.ai/docs/user-guide/data-processing/opentelemetry/openobserve-python-sdk

Install the SDK from PyPI (recommended), from source for development, or via a requirements.txt file. Both HTTP/Protobuf and gRPC protocols are included in all installations.

```bash
# From PyPI (recommended)
pip install openobserve-telemetry-sdk

# From source (development)
pip install -e .

# Using requirements.txt
pip install -r requirements.txt
```

--------------------------------

### Start Python application server

Source: https://openobserve.ai/docs/ingestion/traces/python

Starts the sample Python application server. After running, navigate to http://127.0.0.1:5000 and refresh the page to generate traces.

```bash
python3 app.py

```

--------------------------------

### Get OpenObserve Credentials - curl Command

Source: https://openobserve.ai/docs/integration/devops/github-actions

Example curl command from the OpenObserve UI used to obtain the endpoint, username, and key. Replace placeholders with your actual values.

```bash
curl -u you@yourdomain.com:18qlg4b673Rgdgd2 -k https://api.openobserve.ai/api/your_organization/<stream_name>/_json -d [JSON-DATA]
```

--------------------------------

### Execution Tree Visual Guide

Source: https://openobserve.ai/docs/user-guide/data-exploration/logs/explain-analyze-query

A visual representation of the execution tree, showing operators from bottom (start) to top (end). Read from bottom to top to understand data flow.

```plaintext
┌─────────────────────────────────┐
│ SortPreservingMergeExec         │ ← Final results
└─────────────────────────────────┘
              ▲
              │ 
              │
┌─────────────────────────────────┐
│ ProjectionExec                  │
└─────────────────────────────────┘
              ▲
              │
┌─────────────────────────────────┐
│ FilterExec                      │
└─────────────────────────────────┘
              ▲
              │
┌─────────────────────────────────┐
│ DataSourceExec                  │ ← Starts here
└─────────────────────────────────┘
```

--------------------------------

### Multi-agent handoffs with tools

Source: https://openobserve.ai/docs/integration/ai/frameworks/openai-agents

Instruments a multi-agent setup with a weather tool and handoffs. The example defines a specialist agent and a triage agent that routes questions to the specialist, then runs the triage agent.

```python
from dotenv import load_dotenv
load_dotenv()

from openinference.instrumentation.openai_agents import OpenAIAgentsInstrumentor
from openobserve import openobserve_init

OpenAIAgentsInstrumentor().instrument()
openobserve_init()

import asyncio
from agents import Agent, Runner, function_tool

@function_tool
def get_weather(city: str) -> str:
    """Return current weather for a city."""
    return f"Sunny, 22°C in {city}"

agent = Agent(
    name="WeatherAgent",
    instructions="Use get_weather to answer weather questions.",
    model="gpt-4o-mini",
    tools=[get_weather],
)

async def main():
    result = await Runner.run(agent, "What is the weather in London?")
    print(result.final_output)

asyncio.run(main())
```

--------------------------------

### Instrument AutoGen with AutogenInstrumentor

Source: https://openobserve.ai/docs/integration/ai/frameworks/autogen

Call `AutogenInstrumentor().instrument()` before importing AutoGen. This example loads environment variables, initializes the instrumentor and OpenObserve, then creates an assistant and user proxy agent to start a chat.

```python
from dotenv import load_dotenv
load_dotenv()

from openinference.instrumentation.autogen import AutogenInstrumentor
from openobserve import openobserve_init

AutogenInstrumentor().instrument()
openobserve_init()

import os
import autogen

config_list = [{"model": "gpt-4o-mini", "api_key": os.environ["OPENAI_API_KEY"]}]

assistant = autogen.AssistantAgent(
    name="assistant",
    llm_config={"config_list": config_list},
    system_message="You are a helpful assistant. Keep answers brief.",
)

user = autogen.UserProxyAgent(
    name="user",
    human_input_mode="NEVER",
    max_consecutive_auto_reply=1,
    is_termination_msg=lambda x: True,
)

user.initiate_chat(assistant, message="Explain OpenTelemetry in one sentence.")
```
Tokens:
Raw