Skip to content

Commit

Permalink
[EDU-5478] refactor: update existing docs to add information related …
Browse files Browse the repository at this point in the history
…to botManagerBreakdownMetrics dataset and graphs (#1322)

* [EDU-5497] fix: adjust broken links in Docs (#1314)

* fix: broken links - graphql PT

* fix: broken link - manage bots PT

* refactor: add link to table in Features-gql EN/PT

* refactor: add dataset fields to metrics-fields EN/PT

* refactor: add graphs description to Metrics ref - EN/PT

* Update src/content/docs/pt-br/pages/menu-principal/referencia/observe/real-time-metrics/real-time-metrics.mdx

* Update src/content/docs/en/pages/main-menu/reference/observe/real-time-metrics/real-time-metrics.mdx
  • Loading branch information
MarianaAguilera authored Oct 10, 2024
1 parent fe78c39 commit 7c375fb
Show file tree
Hide file tree
Showing 9 changed files with 136 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Four datasets are deprecated and were replaced by other datsets:
| tieredCacheMetrics | Request events registered by [Tiered Cache](/en/documentation/products/build/edge-application/tiered-cache/) |
| connectedUsersMetrics | Query the number of users connected to your applications, using [Live Ingest](/en/documentation/products/guides/query-connected-users-data-with-graphql/) |
| botManagerMetrics | Query the number of requests evaluated and the actions performed by [Azion Bot Manager](/en/documentation/products/guides/query-bot-manager-data-with-graphql/) (if subscribed) |
| botManagerBreakdownMetrics | Query the URLs most impacted by bad bots, according to [Azion Bot Manager](/en/documentation/products/guides/query-bot-manager-breakdown-data-with-graphql/) data (if subscribed) |

<LinkButton link="/en/documentation/devtools/graphql-api/features/gql-real-time-metrics-fields/" label="see Real-Time Metrics GraphQL API fields descriptions" severity="secondary" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -263,14 +263,43 @@ You can use other parameters to filter and query more specific data. Read more o

### Calculated fields

When a field results from any kind of calculation, such as a sum, theyre considered as *calculated fields*.
When a field results from any kind of calculation, such as a sum, they're considered as *calculated fields*.

| Calculated field | Description |
|----------|----------|
| `requests` | Total amount of requests analyzed by Azion Bot Manager. This field is the result of a sum. Example: `11` |

---

## botManagerBreakdownMetrics

:::note
To retrieve this data, you must be subscribed to Azion Bot Manager. Contact the [Sales team](https://www.azion.com/en/contact-sales/) for more details on the subscription.
:::

| Field | Description |
|----------|----------|
| `host` | Host information sent on the request line. Stores: host name from the request line, or host name from the `Host` request header field, or the server name matching a request. Example: `hello.myhost.net` |
| `remoteAddr` | IP address of the origin that generated the request. Example: `127.0.0.1` |
| `requestUrl` | URL of the request made by the end user, with the host and path information and without arguments. Example: `hello.myhost.net/v1` |
| `ts` | Timestamp of when the event was created. Example: `2022-10-20T10:10:10` |

:::tip
You can use other parameters to filter and query more specific data. Read more on [GraphQL API filtering](/en/documentation/devtools/graphql-api/features/#filtering).
:::

### Calculated fields

When a field results from any kind of calculation, such as a sum, they're considered as *calculated fields*.

| Calculated field | Description |
|----------|----------|
| `badBotRequests` | Total amount of requests classified as bad bots. This field is the result of a sum. Example: `12` |
| `botRequests` | Total amount of requests classified as bots. This field is the result of a sum. Example: `11` |
| `uniqRequestUrl` | Number of unique URLs accessed by bots. This field represents the count of distinct URLs requested by bots. Example: `5` |

---

## Deprecated datasets

The following datasets were discontinued. It's recommended to use the [new datasets which replaced them](/en/documentation/devtools/graphql-api/features/#datasets).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -404,39 +404,41 @@ By using Edge DNS, your domains are hosted and managed on Azion. Then, whenever

### Bot Manager

The **Bot Manager** tab displays metrics related to Bot Manager activity.
The **Bot Manager** tab displays metrics related to Bot Manager activity. It has two sections: **Overview** and **Breakdwon**.

:::note
To visualize these graphs, you must be subscribed to Azion Bot Manager. Contact the [Sales team](https://www.azion.com/en/contact-sales/) for more details on the subscription.
:::

Find out more about each chart:

#### Bad Bot Hits
#### Overview

##### Bad Bot Hits

The Bad Bot Hits graph shows the total number of requests identified as bad bots within the defined period.

Azion Bot Manager analyzes incoming requests and gives them a score. If the score is equal to or greater than the predetermined threshold you set when configuring Bot Manager, the request is considered a bad bot, and the defined action is executed. Otherwise, the request is processed.

#### Good Bot Hits
##### Good Bot Hits

The Good Bot Hits graph shows the number of requests identified as good bots within the defined period.

Azion Bot Manager analyzes incoming requests and gives them a score. If the score is equal to or greater than the predetermined threshold you set when configuring Bot Manager, the request is considered a bad bot, and the defined action is executed. Otherwise, the request is processed normally. Good bots are classified as allowed traffic, and their requests proceed as usual.

#### Bot Hits
##### Bot Hits

The Bot Hits graph shows the total number of requests identified as bots within the defined period. A request is considered a bot when it exhibits non-human characteristics or behavior, including abnormal patterns, missing or unusual request headers, suspicious user-agent strings, requests from IP addresses with a history of malicious activity, failing challenges such as CAPTCHAs, or automation tools.

In this context, bots can be either good or bad. Good bots, like search engine crawlers, are permitted. Bad bots, however, engage in harmful activities like scraping data, launching attacks, or overloading systems.

Azion Bot Manager analyzes incoming requests and gives them a score. If the score is equal to or greater than the predetermined threshold you set when configuring Bot Manager, the request is considered a bad bot, and the defined action is executed. Otherwise, the request is processed.

#### Transactions
##### Transactions

The Transactions graph shows a sum referring to the total number of requests evaluated by Azion Bot Manager.

#### Bot Traffic
##### Bot Traffic

The Bot Traffic graph shows the evolution of bot traffic over time. It presents historical data by identifying the traffic into:

Expand All @@ -447,7 +449,7 @@ The Bot Traffic graph shows the evolution of bot traffic over time. It presents

It helps to identify periods of suspicious activity and allows you to detect patterns and anomalies. By hovering over the lines in the graph, a card will appear with more detailed information about the date, time, and the number of bots in each category.

#### Top Bot Action
##### Top Bot Action

The Top Bot Action graph shows the actions performed by Azion Bot Manager for accesses identified as bots.

Expand All @@ -461,7 +463,7 @@ These actions could be:
- **Random_delay**: made the function wait for a random period between *1 and 10 seconds* before allowing the request to proceed.
- **Hold_connection**: held the request, keeping the connection open for *1 minute* before dropping it.

#### Bot CAPTCHA line graph
##### Bot CAPTCHA line graph

The Bot CAPTCHA metric refers to the results of the challenge returned for requests classified as bots. This metric is presented in two graphics: a pie and a line graph.

Expand All @@ -472,7 +474,7 @@ In the case of the line graph, it displays the traffic identified as bots over t

By hovering over the lines in the graph, a card will appear with more detailed information about the date and time, as well as the number of bots that either passed or failed the CAPTCHA.

## Top Bot CAPTCHA Pie Graph
### Top Bot CAPTCHA Pie Graph

The Bot CAPTCHA metric refers to the results of the challenge returned for requests classified as bots. This metric is presented in two graphics: a pie and a line graph.

Expand All @@ -483,11 +485,11 @@ In the case of the pie graph, it displays the percentage of bots that either pas

It helps to adjust the difficulty or frequency of challenges to improve bot detection. It's also useful for optimizing user experience and the effectiveness in bot mitigation.

#### Top Bot Classifications
##### Top Bot Classifications

The Top Bot Classifications graph shows you the *sum* of requests classified according to the tactics used and the purpose of the bots, including Crawling, Brute Force, Scraping, Bad Bot Signatures, Malicious Browser Behavior, Scripted Bots, Enterprise Bots, Reputation Intelligence, Monitoring Bots, and Malicious Intent Detected, among others.

#### Bot Activity Map
##### Bot Activity Map

The Bot Activity Map displays the geographic origin of bot attacks.

Expand All @@ -501,6 +503,29 @@ Countries are color-coded based on the number of detected bot attacks:

This information helps you identify regional patterns and implement geo-blocking and other region-specific mitigation strategies.

#### Breakdown

##### Impacted URLs

The Impacted URLs graph shows the total number of distinct URLs bots request.

##### Top Impacted URLs

The Top Impacted URLs graph shows the total number of requests detected as bots, broken down by the most affected URLs.

This allows you to identify which URLs are most frequently targeted by bots, empowering you to analyze patterns and define more protective measures.

##### Top Bad Bot IPs

The Top Bad Bot IPs graph shows the total number of requests detected as bad bots from different IP addresses, listing those with the highest activity.

You can use this data to:

- Identify IP addresses frequently used by bad bots to attack your site.
- Discover trends and patterns in bad bot activity.
- Block or limit traffic from risky IP addresses.
- Gain insights to respond quickly to bad bots attacks.

---

## Observe
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,35 @@ Quando um campo resulta de qualquer tipo de cálculo, como uma soma, eles são c

---

## botManagerBreakdownMetrics

:::note
Para consultar esses dados, você deve ter o Azion Bot Manager ativo. Entre em contato com a [equipe de vendas](https://www.azion.com/pt-br/contate-vendas/) para mais detalhes sobre a assinatura.
:::

| Campo | Descrição |
|----------|----------|
| `host` | Informações do host enviadas na linha de requisição. Armazena: nome do host da linha de requisição, ou nome do host do campo de cabeçalho `Host`, ou o nome do servidor que corresponde a uma requisição. Exemplo: `hello.myhost.net` |
| `remoteAddr` | Endereço IP da origem que gerou a requisição. Exemplo: `127.0.0.1` |
| `requestUrl` | URL da requisição feita pelo usuário final, com as informações de host e caminho, e sem argumentos. Exemplo: `hello.myhost.net/v1` |
| `ts` | Timestamp de quando o evento foi criado. Exemplo: `2022-10-20T10:10:10` |

:::tip
Você pode usar outros parâmetros para filtrar e consultar dados mais específicos. Leia mais sobre [filtragem na API GraphQL](/pt-br/documentacao/devtools/graphql-api/recursos/#filtrar).
:::

### Campos calculados

Quando um campo resulta de qualquer tipo de cálculo, como uma soma, eles são considerados como *campos calculados*.

| Campo calculado | Descrição |
|----------|----------|
| `badBotRequests` | Quantidade total de requisições classificadas como bots maliciosos. Este campo é o resultado de uma soma. Exemplo: `12` |
| `botRequests` | Quantidade total de requisições classificadas como bots. Este campo é o resultado de uma soma. Exemplo: `11` |
| `uniqRequestUrl` | Número de URLs únicas acessadas por bots. Este campo representa a contagem de URLs distintas solicitadas por bots. Exemplo: `5` |

---

## Conjuntos de dados descontinuados

Os seguintes conjuntos de dados foram descontinuados. Recomenda-se utilizar os [novos conjuntos que substituiram eles](/pt-br/documentacao/devtools/graphql-api/recursos/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Quatro conjuntos de dados foram descontinuados e substituiídos por outros:
| tieredCacheMetrics | Eventos de requisições registradas pelo [Tiered Cache](/pt-br/documentacao/produtos/build/edge-application/tiered-cache/) |
| connectedUsersMetrics | Consulte o número de usuários conectados às suas aplicações, usando [Live Ingest](/pt-br/documentacao/produtos/guias/query-dados-connected-users-com-graphql/) |
| botManagerMetrics | Consulte o número de requisições avaliadas e as ações realizadas pelo [Azion Bot Manager](/pt-br/documentacao/produtos/guias/consultar-dados-bot-manager-com-graphql/) (se inscrito) |
| botManagerBreakdownMetrics | Consulte as URLs mais impactadas por bots maliciosos, de acordo com os dados do [Azion Bot Manager](/pt-br/documentacao/produtos/guias/consultar-dados-bot-manager-breakdown-com-graphql/) (se inscrito) |

<LinkButton link="/pt-br/documentacao/devtools/graphql-api/recursos/campos-gql-real-time-metrics/" label="veja as descrições dos Campos da API GraphQL do Real⁠-⁠Time Metrics" severity="secondary" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Para recuperar esses dados, você deve estar inscrito no Azion Bot Manager e usa

Para consultar seus dados, siga os passos:

1. Acesse o [playground GraphiQL](https://manager.azion.com/metrics/graphql).
1. Acesse o playground GraphiQL visitando o link `https://manager.azion.com/metrics/graphql`.
- Você deve estar logado na sua conta Azion. Caso contrário, você receberá uma mensagem de erro.
2. Envie uma query seguindo este formato:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -733,39 +733,41 @@ Ao usar o Edge DNS, seus domínios são hospedados e gerenciados na Azion. Entã

### Bot Manager

A aba Bot Manager Advanced exibe métricas relacionadas à atividade do Bot Manager.
A aba Bot Manager Advanced exibe métricas relacionadas à atividade do Bot Manager. A aba contêm duas seções: **Overview** e **Breakdwon**.

:::note
Para consultar esses dados, você deve ter o Azion Bot Manager Advanced ativo. Entre em contato com a [equipe de vendas](https://www.azion.com/pt-br/contate-vendas/) para mais detalhes sobre a assinatura.
:::

Saiba mais sobre cada gráfico:

#### Bad Bot Hits
#### Overview

##### Bad Bot Hits

O gráfico Bad Bot Hits mostra o número total de requisições identificadas como bots maliciosos dentro do período definido.

O Azion Bot Manager analisa as requisições recebidas e atribui uma pontuação a elas. Se a pontuação for igual ou superior ao limite predeterminado que você definiu ao configurar o Bot Manager, a requisição é considerada um bot malicioso, e a ação definida é executada. Caso contrário, a requisição é processada.

#### Good Bot Hits
##### Good Bot Hits

O gráfico Good Bot Hits mostra o número de requisições identificadas como bots bons dentro do período definido.

O Azion Bot Manager analisa as requisições recebidas e atribui uma pontuação a elas. Se a pontuação for igual ou superior ao limite predeterminado que você definiu ao configurar o Bot Manager, a requisição é considerada um bot malicioso, e a ação definida é executada. Caso contrário, a requisição é processada normalmente. Bots bons são classificados como tráfego permitido, e suas requisições prosseguem normalmente.

#### Bot Hits
##### Bot Hits

O gráfico Bot Hits mostra o número total de requisições identificadas como bots dentro do período definido. Uma requisição é considerada um bot quando exibe características ou comportamentos não humanos, incluindo padrões anormais, cabeçalhos de requisição ausentes ou incomuns, strings de user-agent suspeitas, requisições de endereços IP com histórico de atividade maliciosa, falhas em desafios como CAPTCHAs ou ferramentas de automação.

Nesse contexto, os bots podem ser bons ou maliciosos. Bots bons, como crawlers de mecanismos de busca, são permitidos. Bots maliciosos, no entanto, se envolvem em atividades prejudiciais, como raspagem de dados, lançamento de ataques ou sobrecarga de sistemas.

O Azion Bot Manager analisa as requisições recebidas e atribui uma pontuação a elas. Se a pontuação for igual ou superior ao limite predeterminado que você definiu ao configurar o Bot Manager, a requisição é considerada um bot malicioso, e a ação definida é executada. Caso contrário, a requisição é processada.

#### Transactions
##### Transactions

O gráfico Transactions mostra uma soma referente ao número total de requisições avaliadas pelo Azion Bot Manager.

#### Bot Traffic
##### Bot Traffic

O gráfico Bot Traffic mostra a evolução do tráfego de bots ao longo do tempo. Ele apresenta dados históricos identificando o tráfego em:

Expand All @@ -776,7 +778,7 @@ O gráfico Bot Traffic mostra a evolução do tráfego de bots ao longo do tempo

Isso ajuda a identificar períodos de atividade suspeita e permite detectar padrões e anomalias. Ao passar o mouse sobre as linhas no gráfico, um card aparecerá com informações mais detalhadas sobre a data, hora e o número de bots em cada categoria.

#### Top Bot Action
##### Top Bot Action

O gráfico Top Bot Action mostra as ações realizadas pelo Azion Bot Manager para acessos identificados como bots.

Expand All @@ -790,7 +792,7 @@ Essas ações podem ser:
- **Random_delay**: fez a função esperar um período aleatório entre *1 e 10 segundos* antes de permitir que a requisição prosseguisse.
- **Hold_connection**: manteve a requisição, mantendo a conexão aberta por *1 minuto* antes de descartá-la.

#### Bot CAPTCHA line graph
##### Bot CAPTCHA line graph

A métrica Bot CAPTCHA refere-se aos resultados do desafio retornado para requisições classificadas como bots. Essa métrica é apresentada em dois gráficos: um gráfico de pizza e um gráfico de linha.

Expand All @@ -801,7 +803,7 @@ No caso do gráfico de linha, ele exibe o tráfego identificado como bots ao lon

Ao passar o mouse sobre as linhas no gráfico, um card aparecerá com informações mais detalhadas sobre a data e hora, bem como o número de bots que passaram ou falharam no CAPTCHA.

## Top Bot CAPTCHA Pie Graph
##### Top Bot CAPTCHA Pie Graph

A métrica Bot CAPTCHA refere-se aos resultados do desafio retornado para requisições classificadas como bots. Essa métrica é apresentada em dois gráficos: um gráfico de pizza e um gráfico de linha.

Expand All @@ -812,11 +814,11 @@ No caso do gráfico de pizza, ele exibe a porcentagem de bots que passaram ou fa

Isso ajuda a ajustar a dificuldade ou frequência dos desafios para melhorar a detecção de bots. Também é útil para otimizar a experiência do usuário e a eficácia na mitigação de bots.

#### Top Bot Classifications
##### Top Bot Classifications

O gráfico Top Bot Classifications mostra a *soma* de requisições classificadas de acordo com as táticas usadas e o propósito dos bots, incluindo Crawling, Brute Force, Scraping, Bad Bot Signatures, Malicious Browser Behavior, Scripted Bots, Enterprise Bots, Reputation Intelligence, Monitoring Bots e Malicious Intent Detected, entre outros.

#### Bot Activity Map
##### Bot Activity Map

O Mapa de Bot Activity Map exibe a origem geográfica dos ataques de bots.

Expand All @@ -830,6 +832,29 @@ Países são codificados por cores com base no número de ataques de bots detect

Essas informações ajudam a identificar padrões regionais e implementar bloqueios geográficos e outras estratégias de mitigação específicas da região.

#### Breakdown

##### Impacted URLs

O gráfico Impacted URLs mostra o número total de URLs distintas solicitadas por bots.

##### Top Impacted URLs

O gráfico Top Impacted URLs mostra o número total de requisições detectadas como bots, dividido pelas URLs mais afetadas.

Isso permite que você identifique quais URLs são mais frequentemente alvo de bots, capacitando você a analisar padrões e definir medidas de proteção mais eficazes.

##### Top Bad Bot IPs

O gráfico Top Bad Bot IPs mostra o número total de requisições detectadas como bots maliciosos provenientes de diferentes endereços IP, listando aqueles com a maior atividade.

Você pode usar esses dados para:

- Identificar endereços IP frequentemente utilizados por bots maliciosos para atacar seu site.
- Descobrir tendências e padrões na atividade de bots maliciosos.
- Bloquear ou limitar o tráfego de endereços IP arriscados.
- Obter insights para responder rapidamente a ataques de bots maliciosos.

---

## Observe
Expand Down
Loading

0 comments on commit 7c375fb

Please sign in to comment.