Skip to content

Update alerts docs #56

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
21 changes: 11 additions & 10 deletions content/docs/alerting/alert-manager.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,20 @@ This is a snippet of Parseable alert configuration, to demonstrate the fields re

```json
{
"type": "alertmanager",
"endpoint": "http://localhost:9093/api/v2/alerts",
"username": "admin",
"password": "admin",
"skip_tls_check": false,
"repeat": {
"interval": "30s",
"times": 5
}
"name":"AlertManagerTarget",
"type": "alertManager",
"endpoint": "https://some.webhook.com",
"username": "username",
"password":"password",
"skipTlsCheck": true,
"notificationConfig": {
"interval": 3,
"times": 7
}
}
```

The `endpoint` field is the URL of the Alertmanager API endpoint. The `username` and `password` fields are the credentials for basic authentication. The `skip_tls_check` field is a boolean to skip TLS certificate verification. The `repeat` field is used to repeat the alert. If it is not set, Parseable will keep sending the alert (with 200s interval) till it is resolved (i.e. the alert is no longer firing).
The `endpoint` field is the URL of the Alertmanager API endpoint. The `username` and `password` fields are the credentials for basic authentication. The `skipTlsCheck` field is a boolean to skip TLS certificate verification. The `notificationConfig` field is used to repeat the alert notification. If it is not set, Parseable will send the notification just once.

Once Parseable alerts are configured to be sent to Alertmanager, you can use Alertmanager to manage the alerts. For example, you can use Alertmanager to route alerts to different receivers, such as email, PagerDuty, or OpsGenie. You can also use Alertmanager to silence alerts.

2 changes: 1 addition & 1 deletion content/docs/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This document is organiszed into specific sections for each sub-system like inge

## Overview

Parseable is shipped as a single unified binary (or container image if you prefer). This includes the Prism UI and Parseable DB. There is no additional dependency to run Parseable.
Parseable is shipped as a single unified binary (or container image if you prefer). This includes the Prism and Parseable DB. There is no additional dependency to run Parseable.

The binary can be run in different modes. You’d generally run standalone mode to test and experience Parseable on your laptop, or a small testing server.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/datasource/log-agents/fluent-bit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ Check if logs are reaching Parseable:
kubectl logs -l app=fluent-bit -n logging | grep postgres
```

View Logs in Parseable UI
View Logs inPrism
Log in to Parseable and Navigate to "Streams" and click on `postgres-logs` (created automatically by Fluent Bit)

Search and filter logs based on timestamps, queries, errors, etc.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/eBPF/ebpf.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ It will take some time to deploy Vector. You can check the status using the comm
kubectl get pods -n vector
```

Now Vector is ready to send the events stored in `/var/run/cilium/tetragon/tetragon.log` file to the Parseable tetrademo dataset. Once this is done, you can verify the log events in Parseable UI.
Now Vector is ready to send the events stored in `/var/run/cilium/tetragon/tetragon.log` file to the Parseable tetrademo dataset. Once this is done, you can verify the log events inPrism.

We have a blog post which guides you through the process of tracking sensitive file access using Tetragon and Parseable. You can read it here.
305 changes: 161 additions & 144 deletions content/docs/features/alerts.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion content/docs/features/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ title: Search

Parseable Observability Platform supports full-text search allowing users to quickly find relevant log data with ease. Parseable’s search engine is optimized for low-latency queries directly on object storage.

You can perform full-text searches using both the Parseable API and the Prism UI, providing flexibility for automation and interactive exploration.
You can perform full-text searches using both the Parseable API and the Prism, providing flexibility for automation and interactive exploration.
2 changes: 1 addition & 1 deletion content/docs/features/smart-cache.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Smart Cache
---

<Callout type="info">
Smart cache is only available to be set-up through API and not natively supported in the UI from Release `v2.0.0` onwards. We are working on adding this feature to Prism UI and it will be available soon.
Smart cache is only available to be set-up through API and not natively supported in the UI from Release `v2.0.0` onwards. We are working on adding this feature to Prism and it will be available soon.
</Callout>

## How it works
Expand Down
2 changes: 1 addition & 1 deletion content/docs/installation/distributed/k8s-helm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Since we're running Parseable in a distributed mode, the ingestor service and qu
kubectl port-forward svc/parseable-ingestor-service 8000:80 -n parseable
```

To access the Parseable UI, you'll need to expose the `parseable-querier-service` service:
To access thePrism, you'll need to expose the `parseable-querier-service` service:

```bash
kubectl port-forward svc/parseable-querier-service 8001:80 -n parseable
Expand Down
2 changes: 1 addition & 1 deletion content/docs/key-concepts/query.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ For example, for a query like `select count(*) as count from app1`, with the que
<EnterpriseBadge /> This feature requires an Enterprise license.
</Callout>

Parseable's LLM based query builder allows you to generate SQL queries based on your natural language query. This feature is available in the Parseable UI and can be accessed from the SQL editor. It can also help with fixing your queries by suggesting corrections based on the query you have written. To use the LLM based query builder, click on the "Generate with AI" button in the SQL editor.
Parseable's LLM based query builder allows you to generate SQL queries based on your natural language query. This feature is available in thePrism and can be accessed from the SQL editor. It can also help with fixing your queries by suggesting corrections based on the query you have written. To use the LLM based query builder, click on the "Generate with AI" button in the SQL editor.

### 1. Choosing Your LLM Provider

Expand Down