Glossário
Consulte stream, fonte de dados, template, data set, endpoint, sampling e os outros termos usados na documentação do Data Stream.
Este glossário define os termos usados pelo Data Stream no Azion Console, na Azion API e em toda a sua documentação.
| Termo | Definição |
|---|---|
| ativo | O estado de um stream que coleta e envia linhas de log, definido pelo switch Active e pelo campo active, true por padrão. Desligá-lo para o stream e mantém suas configurações, e a lista de streams mostra cada um como Active ou Inactive. Uma mudança de estado entra em vigor após um a dois minutos, e Configurações do stream descreve o campo. |
| connector | O rótulo, no Console, do campo de Output que escolhe o tipo de endpoint, que a API carrega em outputs[0].type. A documentação chama o destino de endpoint, e o campo não tem relação com Connectors, um Platform Resource separado. Configurações do stream mapeia cada opção de Connector para o seu tipo na API. |
| data set | O objeto JSON de um template que mapeia cada chave de uma linha de log para uma variável, como "title": "$title". O Console o mostra no campo somente leitura Data Set, e a API o armazena como a string data_set, com até 65.535 caracteres. Uma fonte de dados é de onde vêm os eventos, e o data set escolhe os valores que cada linha de log carrega, como Templates e payload descreve. |
| endpoint | O destino que recebe as linhas de log de um stream, como um SIEM, uma plataforma de big data ou uma plataforma de processamento de streams. Um stream envia para um endpoint, de um entre 11 tipos, definido no array outputs, e o Console rotula o campo como Connector. Endpoints lista os campos de cada tipo. |
| evento | Uma ocorrência que uma fonte de dados registra, como uma requisição a um workload ou uma alteração feita na conta. Um stream renderiza cada evento que envia como uma linha de log, e o sampling define a parcela de eventos que ele envia. Fontes de dados e variáveis lista o que cada fonte de dados registra sobre um evento. |
| filtro de workloads | A opção que limita um stream aos eventos dos workloads que você escolhe, de 1 a 600 IDs de workload da conta. O Console a mostra como Filter Workloads em Option, e a API a carrega como um item de transform filter_workloads. Ao contrário do sampling, ela mantém os outros streams ativos, e Associe workloads a um stream mostra os passos. |
| fonte de dados | A origem dos eventos que um stream coleta: Activity History, Applications, Functions ou WAF Events. Um stream tem uma fonte de dados, definida no campo Data Source e em inputs[0].attributes.data_source como activity_history, workloads, functions_console ou waf. Fontes de dados e variáveis lista as variáveis que cada uma carrega. |
| formato do payload | O modelo que um endpoint Standard HTTP/HTTPS POST preenche para montar cada payload, definido em Payload Format e em payload_format, com até 250 caracteres. O valor padrão $dataset representa as linhas de log do lote, cada uma renderizada a partir do data set e encerrada com o separador de linha de log. Um formato como [$dataset] com o separador , envia um array JSON, e Templates e payload descreve as duas configurações. |
| linha de log | O texto que um template renderiza a partir de um evento, que o stream envia ao endpoint. Os tamanhos de lote contam linhas de log, que algumas páginas chamam de registros. O Real-Time Events as conta por entrega como linhas enviadas, e Templates e payload mostra como um template as formata. |
| linhas enviadas | O número de linhas de log em uma entrega, que o Real-Time Events registra no campo streamedLines de dataStreamedEvents. Cada entrega também registra endpointType, statusCode, dataStreamed e url, então uma entrega rejeitada aparece com o status que o endpoint retornou. Campos da API GraphQL do Real-Time Events lista todos os campos. |
| lote | O grupo de linhas de log que um stream envia em uma entrega, a cada 2.000 linhas de log ou após 60 segundos, o que ocorrer primeiro. Um endpoint Standard HTTP/HTTPS POST também envia um lote que atinge o seu Payload Max Size. O AWS Kinesis Data Firehose envia a cada 500 linhas de log ou 60 segundos, e Limites de Data Stream lista os dois. |
| NDJSON | Newline-delimited JSON, um formato com um objeto JSON por linha, sem [] em volta e sem vírgula entre as linhas. O receptor pode processar um registro por vez. Um endpoint Standard HTTP/HTTPS POST envia NDJSON por padrão, como Templates e payload descreve. |
| payload | O corpo de uma entrega que um stream envia ao seu endpoint, que carrega as linhas de log de um lote. Só um endpoint Standard HTTP/HTTPS POST permite formatar o payload, com o formato do payload e o separador de linha de log. Personalize o payload do HTTP POST mostra os passos. |
| sampling | O item de transform que envia uma porcentagem dos eventos de um stream, de 1 a 100, definida por Sampling Rate (%) ou transform[sampling].attributes.rate. Salvar um stream ativo com sampling, em qualquer taxa, inclusive 100, desativa todos os outros streams da conta. Configure sampling em um stream mostra os passos. |
| separador de linha de log | Os caracteres que encerram cada linha de log no payload de um endpoint Standard HTTP/HTTPS POST, definidos em Payload Log Line Separator e em log_line_separator. O padrão é \n, que coloca cada linha de log em uma linha própria, e o valor aceita até 100 caracteres. É uma configuração do endpoint, não parte do template, como Templates e payload descreve. |
| stream | O objeto do Data Stream que coleta os eventos de uma fonte de dados e renderiza cada um como uma linha de log com um template. Ele envia as linhas em lotes para um endpoint, e a API serve os streams em /v4/workspace/stream/streams. Configurações do stream mostra um objeto de stream completo. |
| template | A definição que transforma cada evento em uma linha de log, composta por um data set que mapeia chaves para variáveis. Todo stream carrega um, seja um template predefinido ou um template personalizado, em transform[render_template].attributes.template, escolhido no campo Template da seção Render Template. Templates e payload descreve os dois tipos. |
| template personalizado | Um template que a sua conta cria, com um nome e um data set que lista as variáveis que você escolhe. O Console o cria no drawer Create Custom Template da seção Render Template e o lista em Custom Templates. Templates e payload descreve o formato, e Crie um template personalizado mostra os passos. |
| template predefinido | Um dos cinco templates que a Azion fornece, listados em Azion’s Templates e marcados com custom: false na API. Os templates predefinidos são Activity History Collector, Applications Event Collector, Applications + WAF Event Collector, Functions Event Collector e WAF Event Collector. Os seus data sets são somente leitura, e Templates e payload lista as variáveis de cada um. |
| transform | O array de um stream que contém os itens aplicados aos eventos antes da entrega: um item render_template e exatamente um item sampling ou filter_workloads. No Console, as seções Transform e Render Template o preenchem. Configurações do stream descreve cada item. |
| variável | Um nome que começa com $, como $time, que um data set mapeia para uma chave. O stream o substitui pelo valor de cada evento, e cada fonte de dados tem as suas próprias variáveis. Fontes de dados e variáveis as lista com um valor de exemplo para cada uma. |
| verificação do endpoint | O teste que o Data Stream executa uma vez por minuto para marcar cada endpoint como disponível, o que exige que todo servidor da Azion o informe como disponível. Enquanto ele está indisponível, o Data Stream não envia nada para ele e descarta os logs desse intervalo. A verificação roda de novo no minuto seguinte, e Como o Data Stream funciona descreve a sequência. |