> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/1.2/deployment/external-components-setup/logging-and-opensearch-deployment.md).

# Logging & OpenSearch Deployment

## Introduction

Logs from different components present on the cluster will be pulled into OpenSearch to display dashboards and compute reports. Fluentd is used to pull captured logs and put into OpenSearch.

## Prerequisites

* The following utilities/tools must be present on the user's machine.
  * `kubectl`, `istioctl`, `helm`, `jq`, `curl`, `wget`, `git`, `bash`, `envsubst`.
* [Keycloak](/1.2/deployment/external-components-setup/keycloak-deployment.md) for Authentication and Sign-in to UI

## Installation

Clone the <https://github.com/openg2p/openg2p-deployment> repo and navigate to [kubernetes/logging](https://github.com/OpenG2P/openg2p-deployment/tree/main/kubernetes/logging) directory.

### Install OpenSearch (and related components)

* Run this to install OpenSearch and related components.

  ```bash
  SANDBOX_HOSTNAME="openg2p.sandbox.net" \
      ./install.sh
  ```
* After installation is successful, OpenSearch dashboards will be accessible at <https://opensearch.openg2p.sandbox.net>, depending on the hostname given above.

### Install Rancher Logging (Fluentd)

1. On Rancher UI, navigate to Apps (or Apps & Marketplace) -> Charts
2. Search and install Logging from the list, with default values.

### Add *Index State Policy* on OpenSearch

* Run this to add ISM Policy (This is responsible for automatically deleting logstash indices after 3 days. Configure the minimum age to delete indices, in the same script below.)

  ```
  ./opensearch-ism-script.sh
  ```

### Configure Rancher Fluentd

* Run this to create *ClusterOutput* (This is responsible for redirecting all logs to OpenSearch.)

  ```
  kubectl apply -f clusteroutput-opensearch.yaml
  ```
* Run this to create a *ClusterFlow* (This is responsible for filtering OpenG2P service logs, from the logs of all pods.)

  ```
  kubectl apply -f clusterflow-all.yaml
  ```

### Filters

Note the filters applied in [clusterflow-all.yaml](https://github.com/OpenG2P/openg2p-deployment/blob/main/kubernetes/logging/clusterflow-all.yaml). You may update the same for your install if required, and rerun the apply command.

### Dashboards

* TODO

### TraceId

* TODO

### Troubleshooting

* TODO


---

# 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 that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openg2p.org/1.2/deployment/external-components-setup/logging-and-opensearch-deployment.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.