Skip to content

Commit

Permalink
[EDU-5972] refactor: update data stream reference and feature: add De…
Browse files Browse the repository at this point in the history
…lete Stream guide. (#1430)

* refactor: adjust Data Stream introduction PT/EN

* refactor: add items to introduction - Data Stream ref EN/PT

* refactor: add missing links in Guides page Observe - EN/PT

* refactor: adjusting intro in Guide - configure stream EN/PT

* refactor: adjust label - first steps Data Stream PT/EN

* feature: create file for delete stream guide - EN/PT

* feature: add content for delete a stream guide - EN/PT

* feature: add link to delete stream guide - Guides page, reference, and observe menu

* Update src/content/docs/en/pages/observe-journey/data-stream/edit-stream/delete-stream.mdx

Co-authored-by: Guilherme Afonso Oliveira  <[email protected]>

* refactor: adjust and update Data Stream - first Steps EN/PT

* refactor: add management section Data Stream - EN/PT

* Apply suggestions from code review

---------

Co-authored-by: Guilherme Afonso Oliveira <[email protected]>
  • Loading branch information
MarianaAguilera and guiafonso-ol authored Jan 16, 2025
1 parent c0efee0 commit eb942a6
Show file tree
Hide file tree
Showing 12 changed files with 200 additions and 50 deletions.
7 changes: 6 additions & 1 deletion src/content/docs/en/pages/guides/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,16 @@ permalink: /documentation/products/guides/

## Observe

- [How to configure Data Stream main settings](/en/documentation/products/guides/use-data-stream/)
- [How to associate domains on Data Stream](/en/documentation/products/guides/data-stream-associate-domains/)
- [How to set a payload on Data Stream](/en/documentation/products/guides/observe/data-stream-set-payload/)
- [How to create a custom template on Data Stream](/en/documentation/products/guides/data-stream-custom-template/)
- [How to configure sampling on Data Stream](/en/documentation/products/guides/observe/configure-sampling/)
- [How to select variables on Data Stream](/en/documentation/products/guides/observe/data-stream-select-variables/)
- [How to stop or delete a data stream](/en/documentation/products/guides/observe/delete-data-stream/)
- [How to customize a dashboard with the Azion plugin on Grafana](/en/documentation/products/guides/azion-plugin-grafana-custom-dash/)
- [How to use a pre-built dashboard with the Azion plugin on Grafana](/en/documentation/products/guides/azion-plugin-grafana-pre-built-dash/)
- [How to use Data Stream](/en/documentation/products/guides/use-data-stream/)
- [How to use an HTTP/HTTPS POST connector to receive data from Data Stream](/en/documentation/products/guides/observe/connector-standard-https-post/)
- [How to use Amazon Kinesis Data Firehose to receive data from Data Stream](/en/documentation/products/guides/endpoint-amazon-kinesis/)
- [How to use Amazon S3 to receive data from Data Stream](/en/documentation/products/guides/endpoint-amazon-s3/)
- [How to use Azion Edge Storage to receive data from Data Stream](/en/documentation/products/guides/connector-azion-edge-storage/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,16 @@ import LinkButton from 'azion-webkit/linkbutton'

**Data Stream** is an [Observe](/en/documentation/products/observe/) product that allows you to feed your stream processing, SIEM, and big data platforms with the event logs from your applications on Azion in real time. To keep an enhanced performance, it uses ASCII encoding to avoid parser issues and problems in data interpretation.

You can choose from which of the available Azion product and domains you want to collect your logs from and connect them to the endpoint of your data analysis platforms. You can also decide which data you want to use on your analysis by choosing among the available variables.
Data Stream is responsible for collecting, grouping, and transmitting raw logs to your chosen destination, providing flexibility for data integration. You can choose from which of the available Azion product and domains you want to collect your logs from and connect them to the endpoint of your data analysis platforms. You can also decide which data you want to use on your analysis by choosing among the available variables.

By creating a Data Stream, you can:
By accessing Data Stream through [Azion Console](https://console.azion.com/data-stream) or [Azion API](https://api.azion.com/#04257075-3691-4b5f-b22b-22a5b6653f3f), you can perform a variety of actions to manage your data flows, including:

- Have an organized set of logs.
- Connect your Data Streams to endpoints.
- [Create a new data stream](/en/documentation/products/guides/use-data-stream/).
- Connect your Data Streams to [endpoints](/en/documentation/products/guides/#observe).
- [Edit data stream settings](/en/documentation/products/guides/use-data-stream/) directly from the list by selecting the stream you want to update.
- [View detailed information](/en/documentation/products/observe/troubleshoot/data-stream-understand-metrics/) about each stream to ensure everything is running smoothly.
- [Delete or stop data streams](/en/documentation/products/guides/observe/delete-data-stream/) that are no longer needed to optimize your system.
- Understand the behavior of your users.
- Analyze the performance of your content and applications.
- Identify data on security threats.
Expand All @@ -28,18 +32,52 @@ By creating a Data Stream, you can:

After configuring your Data Stream, you can check your logs successfully being sent through [Real-Time Events](/en/documentation/products/observe/real-time-events/).

See the [Data Stream first steps](/en/documentation/products/observe/data-stream/first-steps/).
:::tip
Visit the [Guides page](/en/documentation/products/guides/#observe) and the [Observe section](/en/documentation/products/observe/overview/) to explore more options for managing your data streams.
:::

---

## Implementation

| Task | Guide |
| ---- | ----- |
| Configure Data Stream | [How to use Data Stream](/en/documentation/products/guides/use-data-stream/) |
| Accessing Data Stream | [Data Stream first steps](/en/documentation/products/observe/data-stream/first-steps/) |
| Configure Data Stream | [How to configure Data Stream main settings](/en/documentation/products/guides/use-data-stream/) |
| Stop or delete a data stream| [How to stop or delete a data stream](/en/documentation/products/guides/observe/delete-data-stream/) |
| Associate domains | [How to associate domains on Data Stream](/en/documentation/products/guides/data-stream-associate-domains/) |
| Create customize template | [How to create a custom template on Data Stream](/en/documentation/products/guides/data-stream-custom-template/) |

---

## How to manage Data Stream

Azion Data Stream allows you create, edit, view, and delete data stream configurations.

You can [create a new data stream](/en/documentation/products/guides/use-data-stream/) through [Azion Console](https://console.azion.com/data-stream):

1. Go to **Product menu** > **Data Stream**.
2. Click the **+ Stream** button.
3. Complete the configuration.
4. Click the **Save** button.

To [edit](/en/documentation/products/guides/use-data-stream/) any stream, go to the **Data Stream** page and select the stream you want to work with. Edit the configurations as desired and save the changes.

If you want to [stop a data stream](/en/documentation/products/guides/observe/delete-data-stream/) in your Azion account, follow these steps:

1. [Access Azion Console](https://console.azion.com/) > **Data Stream**.
2. In the list, select the stream you want to stop.
- On the right side of the row, you can see a label indicating the stream's status: **Active** or **Inactive**.
3. On the configuration page, navigate to the Status section.
4. Disable the switch to stop the data streaming.
5. Click the **Save** button.

To activate the streaming again, repeat this process, enabling the switch in the **Status** section.

To [delete](/en/documentation/products/guides/observe/delete-data-stream/) a stream: go to the **Data Stream** page, navigate to the right side of the row, and click the **trash icon** for the stream you want to delete.

---

## Logs

By default, **Data Stream** sends your event logs when the code block with variables reaches *2,000 records*, *every 60 seconds*, or when the packet size reaches the value determined in the *payload Max Size field*, whichever occurs first. However, in case you're using the AWS Kinesis Firehose endpoint, Data Stream will send your event logs when the block reaches *500 records* or every *60 seconds*.
Expand Down Expand Up @@ -356,7 +394,7 @@ To configure the [Azure Monitor](https://azure.microsoft.com/en-us/products/moni

<LinkButton severity="secondary" link="/en/documentation/products/guides/endpoint-azure-monitor/" label="How to use Azure Monitor to receive data" />


---

### Datadog

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,19 @@ permalink: /documentation/products/observe/data-stream/first-steps/

Before beginning to use **Data Stream**, make sure you have a [Azion Console](https://console.azion.com) account. You can find more information on creating one on the [documentation page](/en/documentation/products/accounts/creating-account/).

As Data Stream is a billed product, you must also make sure you have it activated:

1. Log in to [Azion Console](https://console.azion.com).
2. On the upper-right corner, select the avatar menu. This is the **Account menu**.
3. Select **Billing & Subscriptions**.
4. Select the **Subscriptions** tab.
5. On the **Edge Analytics** section, turn on the **Data Stream** switch.

> See more information about [Data Stream pricing](/en/documentation/products/pricing/).
As Data Stream is a billed product, you must also make sure you have it activated in your account. [Contact the Sales team](https://www.azion.com/en/contact-sales/) for more details.

To access Data Stream:

1. [On Azion Console](https://console.azion.com), on the upper-left corner, select the **Products menu**.
2. On the **OBSERVE** section, select **Data Stream**.
2. On the **Observe** section, select **Data Stream**.

To find out how to configure a new stream, see the [How to use Data Stream](/en/documentation/products/guides/use-data-stream/) guide.

If you're using Data Stream [with Teams](/en/documentation/products/accounts/teams-permissions/), your stream configurations are available for the users on the account according to their permissions.


:::tip
Check more information about [Data Stream pricing](/en/documentation/products/pricing/).
:::


Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import InterfaceNote from '~/includes/snippets/InterfaceNote/en/snippet.mdx'

<InterfaceNote />

While creating or editing a stream, there are a few specific main configurations you can define and modify.
By accessing Data Stream through [Azion Console](https://console.azion.com/data-stream) or [Azion API](https://api.azion.com/#04257075-3691-4b5f-b22b-22a5b6653f3f), you can perform a variety of actions to manage your data flows, including [create a new data streams](/en/documentation/products/guides/use-data-stream/), connect them to [endpoints](/en/documentation/products/guides/#observe), [edit data streams settings](/en/documentation/products/guides/use-data-stream/), [view detailed information](/en/documentation/products/observe/troubleshoot/data-stream-understand-metrics/) about each stream and [delete or stop data streams](/en/documentation/products/guides/observe/delete-data-stream/) that are no longer needed.

To find more detailed information on the product and each configuration, see the [reference documentation](/en/documentation/products/observe/data-stream/).

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: How to stop or delete a data stream
description: Follow this guide to stop or delete a data stream in your Azion account.
meta_tags: 'Data Stream, how to, use, stream, event, logs, observe, observability'
namespace: docs_data_delete_stream
permalink: /documentation/products/guides/observe/delete-data-stream/
menu_namespace: observeMenu
---

You can stop or delete a data stream in your Azion account if it's no longer needed to optimize your system. To do so, follow the steps in the sections below.

---

## Stopping a data stream

1. [Access Azion Console](https://console.azion.com/) > **Data Stream**.
2. In the list, select the stream you want to stop.
- On the right side of the row, you can see a label indicating the stream's status: **Active** or **Inactive**.
3. On the configuration page, navigate to the Status section.
4. Disable the switch to stop the data streaming.
5. Click the **Save** button.

Wait a few minutes for the changes to propagate.

:::note
To activate the streaming again, repeat this process, enabling the switch in the **Status** section.
:::

---

## Deleting a data stream

1. [Access Azion Console](https://console.azion.com/) > **Data Stream**.
2. In the list, navigate to the right side of the row and click the **trash icon**.
3. In the dialog box, type **Delete** in the field.
4. Click the **Delete** button to complete the process.

Wait a few minutes for the changes to propagate. This action can't be undone.
7 changes: 6 additions & 1 deletion src/content/docs/pt-br/pages/guias/guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,16 @@ permalink: /documentacao/produtos/guias/

## Observe

- [Como configurar as main settings do Data Stream](/pt-br/documentacao/produtos/guias/como-usar-data-stream/)
- [Como associar domínios no Data Stream](/pt-br/documentacao/produtos/guias/data-stream-associar-dominios/)
- [Como adicionar um payload no Data Stream](/pt-br/documentacao/produtos/guias/observe/data-stream-adicionar-payload/)
- [Como criar um template personalizado no Data Stream](/pt-br/documentacao/produtos/guias/data-stream-template-personalizado/)
- [Como configurar sampling no Data Stream](/pt-br/documentacao/produtos/guias/observe/configurar-sampling/)
- [Como parar ou deletar um data stream](/pt-br/documentacao/produtos/guias/observe/deletar-data-stream/)
- [Como selecionar variáveis no Data Stream](/pt-br/documentacao/produtos/guias/observe/data-stream-selecionar-variaveis/)
- [Como personalizar um dashboard com o plugin da Azion no Grafana](/pt-br/documentacao/produtos/guias/azion-plugin-grafana/)
- [Como utilizar o Data Stream](/pt-br/documentacao/produtos/guias/como-usar-data-stream/)
- [Como utilizar um dashboard pré-configurado com o plugin da Azion no Grafana](/pt-br/documentacao/produtos/guias/azion-plugin-grafana-dash-pre-configurado/)
- [Como utilizar um conector HTTP/HTTPS POST para receber dados do Data Stream](/pt-br/documentacao/produtos/guias/observe/conector-standard-https-post/)
- [Como utilizar o Amazon Kinesis Data Firehose para receber dados do Data Stream](/pt-br/documentacao/produtos/guias/amazon-kinesis-endpoint/)
- [Como utilizar o Amazon S3 para receber dados do Data Stream](/pt-br/documentacao/produtos/guias/amazon-s3-endpoint/)
- [Como utilizar o Azure Blob Storage para receber dados do Data Stream](/pt-br/documentacao/produtos/guias/azure-blob-endpoint/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,70 @@ import LinkButton from 'azion-webkit/linkbutton'

**Data Stream** é um produto de [Observe](/pt-br/documentacao/produtos/observe/) que permite que você alimente suas plataformas de stream, SIEM e big data com os logs de eventos de suas aplicações na Azion em tempo real. Para manter uma performance avançada, usa a codificação ASCII para evitar problemas de parser e problemas na interpretação dos dados.

Você pode escolher de quais produtos e domínios disponíveis na Azion deseja coletar seus dados de logs e conectá-los ao endpoint de sua plataforma de análise de dados. Você também pode escolher quais variáveis quer usar em sua análise.

Ao criar um stream, você consegue:

- Ter um conjunto de logs organizado.
- Conectar o seu stream a endpoints.
- Entender o comportamento de seus usuários.
- Identificar dados de ameaças à segurança.
- Tomar decisões informadas.
- Aperfeiçoar suas aplicações e seu negócio através de práticas confiáveis de observabilidade.

Após configurar seu stream, você pode conferir os seus logs de dados sendo enviados com sucesso através do [Real-Time Events](/pt-br/documentacao/produtos/observe/real-time-events/).
O Data Stream é responsável por coletar, agrupar e transmitir logs brutos para o destino escolhido, oferecendo flexibilidade para a integração de dados. Você pode escolher de quais produtos e domínios disponíveis na Azion deseja coletar seus dados de logs e conectá-los ao endpoint de sua plataforma de análise de dados. Você também pode escolher quais variáveis quer usar em sua análise.

Ao acessar o Data Stream por meio do [Azion Console](https://console.azion.com/data-stream) ou da [Azion API](https://api.azion.com/#04257075-3691-4b5f-b22b-22a5b6653f3f), você pode realizar diversas ações para gerenciar seus fluxos de dados, incluindo:

- Manter um conjunto organizado de logs.
- [Criar um novo data stream](/pt-br/documentacao/produtos/guias/como-usar-data-stream/).
- Conectar seus data streams a [endpoints](/pt-br/documentacao/produtos/guias/#observe).
- [Editar as configurações de um data stream](/pt-br/documentacao/produtos/guias/como-usar-data-stream/) diretamente da lista ao selecionar o stream que deseja atualizar.
- [Visualizar informações detalhadas](/pt-br/documentacao/produtos/observe/troubleshoot/data-stream-monitorar-metricas/) sobre cada stream para garantir que tudo esteja funcionando corretamente.
- [Excluir ou parar data streams](/pt-br/documentacao/produtos/guias/observe/deletar-data-stream/) que não são mais necessários para otimizar seu sistema.
- Compreender o comportamento dos seus usuários.
- Analisar o desempenho do seu conteúdo e das suas aplicações.
- Identificar dados relacionados a ameaças de segurança.
- Tomar decisões informadas.
- Melhorar suas aplicações e seu negócio por meio de práticas confiáveis de observabilidade.

Após configurar o seu Data Stream, você pode verificar o envio bem-sucedido dos seus logs por meio do [Real-Time Events](/pt-br/documentacao/produtos/observe/real-time-events/).

:::tip
Visite a [página de Guias](/pt-br/documentacao/produtos/guias/#observe) e a [seção Observe](/pt-br/documentacao/produtos/observe/visao-geral/) para explorar mais opções de gerenciamento dos seus data streams.
:::

Veja os [primeiros passos do Data Stream](/pt-br/documentacao/produtos/observe/data-stream/primeiros-passos/).
---

## Implementação

| Tarefa | Guia |
| ---- | ----- |
| Configurar Data Stream | [Como utilizar o Data Stream](/pt-br/documentacao/produtos/guias/como-usar-data-stream/) |
| Acessar o Data Stream | [Primeiros passos do Data Stream](/pt-br/documentacao/produtos/observe/data-stream/primeiros-passos/) |
| Configurar o Data Stream | [Como configurar as main settings do Data Stream](/pt-br/documentacao/produtos/guias/como-usar-data-stream/) |
| Parar ou deletar um data stream | [Como parar ou deletar um data stream](/pt-br/documentacao/produtos/guias/observe/deletar-data-stream/) |
| Associar domínios | [Como associar domínios no Data Stream](/pt-br/documentacao/produtos/guias/data-stream-associar-dominios/) |
| Criar template personalizado | [Como criar um template personalizado no Data Stream](/pt-br/documentacao/produtos/guias/data-stream-template-personalizado/) |

---

## Como gerenciar o Data Stream

O Data Stream permite que você crie, edite, visualize e exclua configurações de data stream.

Você pode [criar um novo data stream](/pt-br/documentacao/produtos/guias/como-usar-data-stream/) através do [Azion Console](https://console.azion.com/data-stream):

1. Acesse **Products menu** > **Data Stream**.
2. Clique no botão **+ Stream**.
3. Complete a configuração.
4. Clique no botão **Save**.

Para [editar qualquer stream](/pt-br/documentacao/produtos/guias/como-usar-data-stream/), acesse a página do Data Stream e selecione o stream com o qual deseja trabalhar. Edite as configurações conforme desejado e salve as alterações.

Se você deseja [parar um data stream](/pt-br/documentacao/produtos/guias/observe/deletar-data-stream/) em sua conta Azion, siga estas etapas:

1. Acesse o Azion Console > **Data Stream**.
2. Na lista, selecione o stream que deseja parar.
3. No lado direito da linha, você pode ver uma label indicando o status do stream: Active ou Inactive.
4. Na página de configuração, navegue até a seção **Status**.
5. Desative o switch para parar o data streaming.
6. Clique no botão **Save**.

Para ativar o streaming novamente, repita este processo, ativando o switch na seção **Status**.

Para [excluir um stream](/pt-br/documentacao/produtos/guias/observe/deletar-data-stream/): acesse a página Data Stream, navegue até o lado direito da linha e clique no ícone de lixeira para o stream que deseja excluir.

---

## Logs

Por padrão, o **Data Stream** envia seus logs de eventos quando o bloco com as variáveis atinge *2.000 registros*, a cada *60 segundos*, ou quando o tamanho do pacote atinge o valor determinado no *campo Max Size do payload*, o que ocorrer primeiro. No entanto, se você estiver usando o endpoint AWS Kinesis Data Firehose, o Data Stream enviará seus logs de eventos quando o bloco atingir *500 registros* ou a cada *60 segundos*.
Expand Down
Loading

0 comments on commit eb942a6

Please sign in to comment.