Skip to content

Commit

Permalink
listener-agent: fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
Radim Daniel Panek authored and Radim Daniel Panek committed Sep 4, 2023
1 parent 6c29598 commit 436b49a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 20 deletions.
30 changes: 10 additions & 20 deletions docs/listener/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The Listener Agent is distributed as a [Docker](https://quay.io/repository/canar

The [Docker](https://quay.io/repository/canarytrace/listener-agent?tab=tags) image contains not only the Listener engine itself but also built-in rules and the necessary Kubernetes deployment objects.

Upon launching the Docker image with the Listener Agent, the creation of service indices in Elasticsearch happens automatically, followed by the start of individual phases. Once the final phase ends, the Docker image stops and restarts. Thanks to this, the Listener Agent evaluates current data from Canarytrace RUM and Canarytrace Synthetic.
Upon launching the Docker image with the Listener Agent, the creation of service indices in Elasticsearch happens automatically, followed by the start of individual phases. Once the final phase ends, the Docker image stops and re-run. Thanks to this, the Listener Agent evaluates current data from Canarytrace RUM and Canarytrace Synthetic.

For optimal operation, it's necessary to run the Listener Agent in a Kubernetes cluster. More information can be found in the [Kubernetes](#kubernetes) section.

Expand Down Expand Up @@ -281,24 +281,18 @@ DataManager exist: Not found. | 31
The Listener agent comes with pre-defined rules / checklist, so you don't necessarily have to intervene in the configuration from the beginning. However, you will likely want to modify certain rules, and for that, you can override the built-in rules. For this purpose, three files are used.
- `rules/internal.yaml` For the quality rules of web applications, especially for checking data from Canarytrace.
- List of rules [internal.yaml](#internal-rules)
- `rules/rum.yaml` Rules for monitoring data from the [Canarytrace RUM](../rum/introduction)
- List of rules [rum.yaml](#rum-rules)
- `rules/custom.yaml` For your own custom business rules.
- List of rules [custom.yaml](#custom-rules)
- `rules/internal.yaml` For the quality rules of web applications, especially for checking data from Canarytrace. [Go to the list of internal rules](#internal-rules).
- `rules/rum.yaml` Rules for monitoring data from the [Canarytrace RUM](../rum/introduction). [Go to the list of RUM rules](#rum-rules).
- `rules/custom.yaml` For your own custom business rules. [Go to the list of custom rules](#custom-rules).
Všechny tři soubory se deployují do Kubernetes jako [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) a jejich obsah můžete za běhu měnit. Změny se projeví při dalším startu Listener agenta.
All three files are deployed to Kubernetes as a ConfigMap, and you can modify their content during runtime. The changes will take effect upon the next start of the Listener agent.
Jednotlivá pravidla jsou v těchto souborech definována pomocí typů [range](https://github.com/canarytrace/documentation/issues/110#issuecomment-1364990113), [contains](https://github.com/canarytrace/documentation/issues/110#issuecomment-1365282100) a [match](https://github.com/canarytrace/documentation/issues/110#issuecomment-1365444676). Pomocí těchto typů můžete upravit či postavit robustní seznam pravidel pro Vaše business thresholdy.
Individual rules are defined in these files using the '[range](#type-range)', '[contains](#type-contains)', and '[match](#type-match)' types. Using these types, you can modify or construct a robust list of rules for your business thresholds.
Syntaxe v pravidlech slouží pro vygenerování dotazu do Elasticsearch, takže:
The syntax in the rules is used to generate a query in Elasticsearch, so if the rule is true ⇒ the query in Elasticsearch found data corresponding to the rule ⇒ event creation ⇒ reporting.
pokud je pravidlo pravdivé ⇒ dotaz v Elasticsearch našel data, které pravidlu odpovídají ⇒ založení události ⇒ reportování
### `rules/internal.yaml`
### internal rules
> source: rules/internal.yaml
Title | Index | Condition | Count / hour | Score
-- | -- | -- | -- | --
Expand All @@ -323,9 +317,7 @@ Response code 400 | r.request-log | >= 400 | 5 | 80
Response code 500 | r.request-log | >= 500 | 5 | 20
Failed check your page! | c.report | test step failed | 2 | 10
### rum rules
> source: rules/rum.yaml
### `rules/rum.yaml`
Title | Index | Condition | Count / hour | Score
-- | -- | -- | -- | --
Expand All @@ -340,9 +332,7 @@ FCP is poor (RUM) | c.rum.metrics | >= 3000 | 3 | 20
TTFB needs improvement (RUM) | c.rum.metrics | 400 - 800 | 3 | 40
TTFB is poor (RUM) | c.rum.metrics | >= 800 | 3 | 20
### custom rules
> source: rules/custom.yaml
### `rules/custom.yaml`
It contains only an example of a possible business rule (maximum time for user login to the application).
Expand Down
1 change: 1 addition & 0 deletions src/components/LicenseInfo.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import React from 'react';
function LicenseInfo({app}) {
return (
<>
<p></p>
<div className="theme-admonition theme-admonition-tip alert alert--success admonition_node_modules-@docusaurus-theme-classic-lib-theme-Admonition-styles-module"><div className="admonitionHeading_node_modules-@docusaurus-theme-classic-lib-theme-Admonition-styles-module"><span className="admonitionIcon_node_modules-@docusaurus-theme-classic-lib-theme-Admonition-styles-module"><svg viewBox="0 0 12 16"><path fillRule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div className="admonitionContent_node_modules-@docusaurus-theme-classic-lib-theme-Admonition-styles-module"><p>To run {app}, you will need a valid license. If you do not have one, please contact us.</p></div></div>
</>
);
Expand Down

0 comments on commit 436b49a

Please sign in to comment.