fcakyon/claude-codex-settings / plugins/openobserve-skills/skills/openobserve-api
openobserve-api
UnverifiedThis skill should be used when user asks to "query OpenObserve", "create OpenObserve dashboard", "edit OpenObserve panel", "fetch OpenObserve logs", "run OpenObserve search", "list OpenObserve streams", "ingest into OpenObserve", or works with OpenObserve Cloud / self-hosted via REST API. Covers auth, search/SQL, streams, dashboards (CRUD + per-panel ops), the v8 panel JSON schema, and known pitfalls (re-aggregation, hash concurrency, microsecond timestamps).
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 16.1 KB |
| references/around.md | markdown | 2.5 KB |
| references/bulk.md | markdown | 7.0 KB |
| references/delete.md | markdown | 10.8 KB |
| references/index.md | markdown | 1.7 KB |
| references/json.md | markdown | 6.8 KB |
| references/list.md | markdown | 2.7 KB |
| references/loki.md | markdown | 2.8 KB |
| references/multi.md | markdown | 5.2 KB |
| references/otlp.md | markdown | 4.4 KB |
| references/recipes/build-dashboard.shexecutable | script | 1.5 KB |
| references/recipes/search-logs.shexecutable | script | 683 B |
| references/recipes/update-panel.shexecutable | script | 884 B |
| references/schema.md | markdown | 2.6 KB |
| references/search.md | markdown | 13.3 KB |
| references/setting.md | markdown | 5.8 KB |
| references/value.md | markdown | 1.9 KB |
references/schema.md
View on GitHub---
title: Schema
description: Retrieve schema, stats, and settings for a log, metric, or trace stream in OpenObserve via GET API. Includes timestamps, field types, and storage info.
---
# Get schema for stream
Endpoint: `GET /api/{organization}/streams/{stream}/schema?type={StreamType}`
## Request
- type: logs / metrics / traces
default is `logs`.
## Response
```json
{
"name": "k8s",
"storage_type": "s3",
"stream_type": "logs",
"stats": {
"doc_time_min": 1673715046856933,
"doc_time_max": 1673849134852901,
"doc_num": 3300000,
"file_num": 16,
"storage_size": 3323.5,
"compressed_size": 11.42
},
"schema": [
{
"name": "_timestamp",
"type": "Int64"
},
{
"name": "kubernetes.annotations.kubernetes.io/psp",
"type": "Utf8"
},
],
"settings": {
"partition_keys": {},
"full_text_search_keys": ["log"]
}
}
```
Description
| Field name | Data type | Default value | Description |
|------------|-----------|---------------|-------------|
| name | string | - | stream name |
| storage_type | string | - | s3 / disk |
| stream_type | string | logs | logs / metrics / traces |
| stats | object | - | stats for the stream |
| stats.doc_time_min | int64 | 0 | the minimum timestamp of the record in the stream |
| stats.doc_time_max | int64 | 0 | the maximum timestamp of the record in the stream |
| stats.doc_num | int64 | 0 | the records num of the stream |
| stats.file_num | int64 | 0 | the files num in storage of the stream |
| stats.storage_size | int64 | 0 | ingestion data size of the original data |
| stats.compressed_size | int64 | 0 | stored size in storage after compression |
| schema | array | - | the schema of the stream, if `fetchSchema` set to false, has no this field |
| schema.name | string | - | field name |
| schema.type | string | - | field data type: Utf8 / Int64 / Float64 / Timestamp / Boolean |
| settings | object | - | settings of the stream |
| settings.partition_keys | object | - | custom partition keys for the stream. By default OpenObserve uses timestamp as the first level partition key |
| settings.full_text_search_keys | array[string] | - | full text search fields, default OpenObserve uses `log`, `message`, `msg`, `content`, `data`, `json`, if there is no those fields in your stream, will report error: `you should set the full text search fields`. |
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| deprecation-and-migrationaddyosmani/agent-skillsManages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when migrating a database schema in production, such as renaming or dropping a column without downtime (expand/contract). Use when deciding whether to maintain or sunset existing code. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| performance-optimizationaddyosmani/agent-skillsOptimizes application performance across frontend, backend, queries, and databases. Use when performance requirements exist, when you suspect performance regressions, when Core Web Vitals or load times need improvement, when N+1 query patterns need fixing, or when profiling reveals bottlenecks. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| Agent Cost Reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |
| Agent Cost Reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |