Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Grafana data source configuration instruction for Quickwit Searcher Lambda #5092

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion distribution/lambda/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Searcher only:
| QW_LAMBDA_PARTIAL_REQUEST_CACHE_CAPACITY | `searcher.partial_request_cache_capacity` node config | 64M |


### Set up a search API
### <a name=set-up-a-search-api />Set up a search API
rdettai marked this conversation as resolved.
Show resolved Hide resolved

You can configure an HTTP API endpoint around the Quickwit Searcher Lambda. The
mock data example stack shows such a configuration. The API Gateway is enabled
Expand Down Expand Up @@ -139,3 +139,24 @@ curl -d '{"query":"quantity:>5", "max_hits": 10}' -H "Content-Type: application/
* `cdk deploy` deploy this stack to your default AWS account/region
* `cdk diff` compare deployed stack with current state
* `cdk docs` open CDK documentation

### Grafana data source setup

You can query and visualize Quickwit Searcher Lambda data from Grafana by using Quickwit data source for Grafana.
rdettai marked this conversation as resolved.
Show resolved Hide resolved

#### Prerequisites

- [Setup HTTP API endpoint for Quickwit Searcher Lambda](#set-up-a-search-api)
tyrwzl marked this conversation as resolved.
Show resolved Hide resolved
- [Install Quickwit data source plugin on Grafana](https://github.com/quickwit-oss/quickwit-datasource#installation)

#### Configure Grafana data source

You need to provide the following information.

|Variable|Description|Example|
|--|--|--|
|HTTP URL| HTTP search endpoint for Quickwit Searcher Lambda | https://*******.execute-api.us-east-1.amazonaws.com/api/v1 |
|Custom HTTP Headers| (Optional) If you configure API Gateway to require an API key, set `x-api-key` HTTP Header | Header: `x-api-key` <br> Value: API key value|
rdettai marked this conversation as resolved.
Show resolved Hide resolved
|Index ID| Same as `QW_LAMBDA_INDEX_ID` | hdfs-logs |

After enter the above values, click "Save & test" and you can query Quickwit data from Grafana!
tyrwzl marked this conversation as resolved.
Show resolved Hide resolved
Loading