# Sunbird Obsrv ## Sunbird Obsrv - [Welcome to Obsrv](https://obsrv.sunbird.org/readme.md) - [The Value of Data](https://obsrv.sunbird.org/readme/the-value-of-data.md): Importance of Data and its use-cases - [Data Value Chain](https://obsrv.sunbird.org/readme/data-value-chain.md): Stages of a Data Value Chain & typical implementation - [Challenges](https://obsrv.sunbird.org/readme/challenges.md): Challenges in implementing and managing a robust Data Value Chain - [The Solution: Obsrv](https://obsrv.sunbird.org/readme/the-solution-obsrv.md): Obsrv: A Resilient and Reliable Data Value Chain Orchestrator - [Core Concepts](https://obsrv.sunbird.org/core-concepts.md): A deep-dive into core concepts of Obsrv - [Obsrv Overview](https://obsrv.sunbird.org/core-concepts/obsrv-overview.md): How & Where does Obsrv fit in the data landscape - [High Level Architecture](https://obsrv.sunbird.org/core-concepts/high-level-architecture.md): Under the hood of Obsrv - [Key Capabilities](https://obsrv.sunbird.org/core-concepts/key-capabilities.md): Key Features to orchestrate the data value chain - [Datasets](https://obsrv.sunbird.org/core-concepts/datasets.md): Definition and details about datasets - a key construct in Obsrv - [Connectors](https://obsrv.sunbird.org/core-concepts/connectors.md): Another key construct of Obsrv which allows it to connect to wide variety of data sources & formats - [Tech Stack](https://obsrv.sunbird.org/core-concepts/tech-stack.md): Technologies Powering Obsrv - [Monitoring](https://obsrv.sunbird.org/core-concepts/monitoring.md): One of innate capabilities of Obsrv to empower seamless operations - [Explore](https://obsrv.sunbird.org/explore.md): Additional details about Obsrv - [Roadmap](https://obsrv.sunbird.org/explore/roadmap.md) - [Case Studies](https://obsrv.sunbird.org/explore/case-studies.md): Real-world scenarios demonstrating the applications of Obsrv - [Agri Climate Advisory](https://obsrv.sunbird.org/explore/case-studies/agri-climate-advisory.md) - [Learning Analytics at Population Scale](https://obsrv.sunbird.org/explore/case-studies/learning-analytics-at-population-scale.md) - [IOT Observations Infra](https://obsrv.sunbird.org/explore/case-studies/iot-observations-infra.md) - [Data Driven Features in Learning Platform](https://obsrv.sunbird.org/explore/case-studies/data-driven-features-in-learning-platform.md) - [Network Observability](https://obsrv.sunbird.org/explore/case-studies/network-observability.md) - [Fraud Detection](https://obsrv.sunbird.org/explore/case-studies/fraud-detection.md) - [Performance Benchmarks](https://obsrv.sunbird.org/explore/performance-benchmarks.md): Proof of the pudding for scalability of Obsrv - [Guides](https://obsrv.sunbird.org/guides.md): Documentation to install and operate an Obsrv instance - [Installation Guide](https://obsrv.sunbird.org/guides/installation.md): Instructions to install Obsrv in various environments. - [AWS](https://obsrv.sunbird.org/guides/installation/aws-installation-guide.md) - [Azure](https://obsrv.sunbird.org/guides/installation/azure-installation-guide.md): Instructions to install in Azure infra - [GCP](https://obsrv.sunbird.org/guides/installation/gcp-installation-guide.md): Instructions to install in GCP infra - [OCI](https://obsrv.sunbird.org/guides/installation/oci-installation-guide.md): Instructions to install in OCI - [Data Center](https://obsrv.sunbird.org/guides/installation/data-center-installation-guide.md): Instructions to install in on-prem data centre - [API Specification](https://obsrv.sunbird.org/guides/api-specification.md) - [Dataset Management APIs](https://obsrv.sunbird.org/guides/api-specification/dataset-management.md): List of APIs to manage datasets - [Connector APIs](https://obsrv.sunbird.org/guides/api-specification/connector-apis.md): List of APIs to manage data input connectors - [Data In & Out APIs](https://obsrv.sunbird.org/guides/api-specification/data-in-and-out-apis.md): List of APIs to write and read data - [Alerts and Notification Channels APIs](https://obsrv.sunbird.org/guides/api-specification/alerts-notification-channel-apis.md): List of APIs to manage alerts and notification channels - [Dataset Management Console](https://obsrv.sunbird.org/guides/management-console-guide.md) - [Developer Guide](https://obsrv.sunbird.org/guides/developer-guide.md): Guide to setup and run in a developer machine - [Example Datasets](https://obsrv.sunbird.org/guides/example-datasets.md) - [OpenTelemetry (OTEL) Integration](https://obsrv.sunbird.org/guides/example-datasets/opentelemetry-otel-integration.md) - [How Tos](https://obsrv.sunbird.org/guides/how-tos.md): Step-by-step recipes for common Obsrv customizations - [Extending Obsrv with Custom Processing Logic](https://obsrv.sunbird.org/guides/how-tos/custom-code-injection.md): Insert your own code (Python, Node.js or any Kafka consumer/producer) alongside the Obsrv dataset processing flow. - [Connectors Developer Guide](https://obsrv.sunbird.org/guides/connectors-developer-guide.md) - [SDK Assumptions](https://obsrv.sunbird.org/guides/connectors-developer-guide/connector-types.md) - [Required Files](https://obsrv.sunbird.org/guides/connectors-developer-guide/required-files.md) - [metadata.json](https://obsrv.sunbird.org/guides/connectors-developer-guide/required-files/metadata-json.md) - [ui-config.json](https://obsrv.sunbird.org/guides/connectors-developer-guide/required-files/ui-config-json.md): This page provides a comprehensive guide for developers on how to create and structure ui-config.json files used for auto-generating UIs for connectors. - [metrics.yaml](https://obsrv.sunbird.org/guides/connectors-developer-guide/required-files/metrics.yaml.md) - [alerts.yaml](https://obsrv.sunbird.org/guides/connectors-developer-guide/required-files/alerts.yaml.md) - [Obsrv Base Setup](https://obsrv.sunbird.org/guides/connectors-developer-guide/obsrv-base-setup.md) - [Dev Requirements](https://obsrv.sunbird.org/guides/connectors-developer-guide/dev-requirements.md) - [Interfaces](https://obsrv.sunbird.org/guides/connectors-developer-guide/interfaces.md) - [Stream Interfaces](https://obsrv.sunbird.org/guides/connectors-developer-guide/interfaces/stream-interfaces.md) - [Batch Interfaces](https://obsrv.sunbird.org/guides/connectors-developer-guide/interfaces/batch-interfaces.md) - [Classes](https://obsrv.sunbird.org/guides/connectors-developer-guide/classes.md) - [ConnectorContext Class](https://obsrv.sunbird.org/guides/connectors-developer-guide/classes/connectorcontext-class.md) - [ConnectorStats Class](https://obsrv.sunbird.org/guides/connectors-developer-guide/classes/connectorstats-class.md) - [ConnectorState Class](https://obsrv.sunbird.org/guides/connectors-developer-guide/classes/connectorstate-class.md) - [ErrorData Class](https://obsrv.sunbird.org/guides/connectors-developer-guide/classes/errordata-class.md) - [MetricData Class](https://obsrv.sunbird.org/guides/connectors-developer-guide/classes/metricdata-class.md) - [Verifying](https://obsrv.sunbird.org/guides/connectors-developer-guide/verifying.md) - [Packaging Guide](https://obsrv.sunbird.org/guides/connectors-developer-guide/packaging.md) - [Reference Implementations](https://obsrv.sunbird.org/guides/connectors-developer-guide/reference-implementations.md) - [Coming Soon!](https://obsrv.sunbird.org/guides/coming-soon.md) - [Community](https://obsrv.sunbird.org/community.md): How to participate in Obsrv community - [Previous Versions](https://obsrv.sunbird.org/previous-versions.md) - [SB-5.0 Version](https://obsrv.sunbird.org/previous-versions/sb-5.0-version.md) - [Overview](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/sb-5.0-version.md) - [USE](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use.md) - [Release Notes](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes.md) - [Obsrv 2.0-Beta](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/release-v-5.2.0.md) - [Obsrv 2.1.0](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/obsrv-2.1.0.md) - [Obsrv 2.2.0](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/obsrv-2.2.0.md) - [Obsrv 2.0.0-GA](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/obsrv-2.0.0-ga.md) - [Obsrv 5.3.0-GA](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/release-v-5.3.0-ga.md) - [Release V 5.1.0](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/release-v-5.1.0.md) - [Release V 5.1.2](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/release-v-5.1.2.md) - [Release V 5.1.3](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/release-v-5.1.3.md) - [Release V 5.0.0](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/release-v-5.0.0.md) - [Release V 4.10.0](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/release-notes/release-v-4.10.5.md) - [Installation Guide](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/installation-guide.md) - [Obsrv 2.0 Installation Guide](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/obsrv-2.0-installation-guide.md) - [Getting Started with Obsrv Deployment Using Helm](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/obsrv-2.0-installation-guide/obsrv-deployment-using-helm.md) - [System Requirements](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/use/system-requirements.md) - [LEARN](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn.md) - [Functional Capabilities](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/functional-capabilities.md): Functional capabilities that can be enabled using Sunbird Obsrv - [Dependencies](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/dependencies.md) - [Product Roadmap](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-roadmap.md) - [Product & Developer Guide](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide.md) - [Telemetry Service](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/telemetry-service.md) - [Data Pipeline](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/data-pipeline.md) - [Data Service](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/data-service.md) - [Data Product](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/data-product.md) - [On Demand Druid Exhaust Job](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/data-product/obsrv-2.0-installation-guide.md) - [Component Diagram](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/data-product/obsrv-2.0-installation-guide/component-diagram.md) - [ML CSV Reports](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/data-product/obsrv-2.0-installation-guide/ml-csv-reports.md) - [Folder Struture](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/data-product/obsrv-2.0-installation-guide/folder-struture.md) - [Report Service](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/report-service.md) - [Report Configurator](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/report-configurator.md) - [Summarisers](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/learn/product-and-developer-guide/summarisers.md) - [ENGAGE](https://obsrv.sunbird.org/previous-versions/sb-5.0-version/engage.md) - [Release Notes](https://obsrv.sunbird.org/release-notes.md) - [Obsrv 1.1.0 Beta Release](https://obsrv.sunbird.org/release-notes/1.1.0-beta.md) - [Obsrv 1.2.0-RC Release](https://obsrv.sunbird.org/release-notes/1.2.0-rc.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://obsrv.sunbird.org/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.