Todos os produtos
Search
Central de documentação

Simple Log Service:UpdateLogtailPipelineConfig

Última atualização: Oct 21, 2026

Atualiza uma configuração de pipeline do Logtail.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

  • API: A API que você pode chamar para executar a ação.

  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

log:UpdateLogtailPipelineConfig

update

*All resources.

*

  • log:TLSVersion
Nenhuma

Sintaxe da solicitação

PUT /pipelineconfigs/{configName} HTTP/1.1

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

configName

string

Sim

O nome da configuração de pipeline do Logtail.

test-config

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

project

string

Sim

O nome do projeto.

test-project

body

object

Não

O conteúdo da configuração de pipeline do Logtail.

aggregators

array<object>

Não

A lista de plug-ins agregadores.

Importante Este parâmetro entra em vigor apenas quando plug-ins de processamento estendidos são usados. É permitido no máximo um plug-in agregador.

object

Não

O plug-in agregador.

configName

string

Sim

O nome da configuração.

Importante Este nome deve ser igual ao valor do parâmetro configName no nível externo.

test-config

flushers

array<object>

Sim

A lista de plug-ins de saída.

Importante Atualmente, apenas um plug-in de saída do Simple Log Service é permitido.

object

Não

O plug-in de saída.

{ "Type": "flusher_sls", "Logstore": "test" }

global

object

Não

As configurações globais.

inputs

array<object>

Sim

A lista de plug-ins de entrada.

Importante Atualmente, apenas um plug-in de entrada pode ser configurado.

object

Não

O plug-in de entrada.

Nota

Para os parâmetros do plug-in de entrada de arquivo, consulte Plug-in de arquivo. Para os parâmetros de outros plug-ins de entrada, consulte Plug-ins de processamento.

{ "Type": "input_file", "FilePaths": ["/var/log/*.log"] }

logSample

string

Não

A amostra de log. Vários logs são suportados.

2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world

processors

array<object>

Não

A lista de plug-ins de processamento.

Nota

Os plug-ins de processamento são divididos em plug-ins de processamento nativos e plug-ins de processamento estendidos. Para mais informações, consulte Plug-ins de processamento.

Importante
Nota
  • Os plug-ins nativos só podem ser usados para coletar logs de texto.

  • Você não pode adicionar plug-ins nativos e plug-ins estendidos ao mesmo tempo.

  • Ao usar plug-ins nativos, os seguintes requisitos devem ser atendidos:
    • O primeiro plug-in de processamento deve ser um plug-in de análise regex, plug-in de análise de delimitador, plug-in de análise JSON, plug-in de análise no modo NGINX, plug-in de análise no modo Apache ou plug-in de análise no modo IIS.

    • Após o primeiro plug-in de processamento, apenas um plug-in de análise de tempo, um plug-in de filtro e vários plug-ins de mascaramento de dados são permitidos.

object

Não

O plug-in de processamento.

Nota

Para mais informações, consulte Plug-ins de processamento.

{ "Type": "processor_parse_json_native", "SourceKey": "content" }

task

object

Não

A configuração da tarefa.

{'taskId': 'xxxxxxxxx'}

Configurações globais

ParâmetroTipoObrigatórioValor padrãoExemploDescrição
TopicTypestringNãoVaziofilepathO tipo de tópico. Valores válidos:
  • filepath: extrai informações do caminho do arquivo de log como o tópico. Este valor é válido apenas quando o plug-in de entrada é input_file.

  • machine_group_topic: usa o tópico do grupo de máquinas ao qual a configuração é aplicada como o tópico.

  • custom: tópico personalizado. Para mais informações, consulte Tópico de log.

TopicFormatstringNão. Obrigatório quando TopicType é definido como filepath ou custom.//var/log/(.*).logO formato do tópico.
EnableTimestampNanosecondboolNãofalsefalseEspecifica se a precisão de nanossegundos para carimbos de data/hora deve ser ativada.
PipelineMetaTagKeyobjectNãoVazio{"HOST_NAME":"__hostname__"}
Importante Suportado apenas pelo LoongCollector 3.0.10 e posterior.
Controla as tags relacionadas às informações do próprio LoongCollector. A chave é o nome do parâmetro da tag, e o valor é o nome do campo da tag no log. Quando o valor é default, o valor padrão é usado. Quando o valor é uma string vazia, a tag é excluída. Você pode configurar as seguintes tags:
  • HOST_NAME: o nome do host. Adicionado por padrão. Valor padrão: "__hostname__".

  • AGENT_TAG: o identificador personalizado. Adicionado por padrão. Valor padrão: "__user_defined_id__".

  • HOST_ID: o ID do host. Não adicionado por padrão. Valor padrão: "__host_id__".

  • CLOUD_PROVIDER: o provedor de nuvem. Não adicionado por padrão. Valor padrão: "__cloud_provider__".

Plug-ins de entrada.

Plug-in de entrada de arquivo

ParâmetroTipoObrigatórioValor padrãoExemploDescrição
TypestringSim/input_fileO tipo de plug-in. Defina o valor como input_file.
FilePaths[string]Sim/["/var/log/*.log"]A lista de caminhos de arquivos de log a serem coletados. Atualmente, apenas um caminho é suportado. Você pode usar os curingas * e ** no caminho. O curinga ** pode aparecer apenas uma vez e deve ser usado antes do nome do arquivo.
MaxDirSearchDepthuintNão00A profundidade máxima de diretório para o curinga ** no caminho do arquivo. Este parâmetro é válido apenas quando o curinga ** é usado no caminho do log. Valores válidos: 0 a 1000.
ExcludeFilePaths[string]NãoVazio["/home/admin/*.log"]A lista de exclusão de caminhos de arquivos. Os caminhos devem ser caminhos absolutos. O curinga * é suportado.
ExcludeFiles[string]NãoVazio["app*.log", "password"]A lista de exclusão de nomes de arquivos. O curinga * é suportado.
ExcludeDirs[string]NãoVazio["/home/admin/dir1", "/home/admin/dir2*"]A lista de exclusão de diretórios. Os caminhos devem ser caminhos absolutos. O curinga * é suportado.
FileEncodingstringNãoutf8utf8O formato de codificação do arquivo. Valores válidos: utf8 e gbk.
TailSizeKBuintNão10241024O tamanho a partir do final do arquivo correspondente até a posição inicial de coleta quando a configuração entra em vigor pela primeira vez. Se o tamanho do arquivo for menor que este valor, a coleta começa do início do arquivo. Valores válidos: 0 a 10485760. Unidade: KB.
MultilineobjectNãoVazio/As opções de agregação multilinha.
Multiline.ModestringNãocustomcustomO modo de agregação multilinha. Valores válidos: custom e JSON.
Multiline.StartPatternstringObrigatório quando Multiline.Mode é definido como custom.Vazio\d+-\d+-\d+.*A expressão regular para a primeira linha de um log.
EnableContainerDiscoveryboolNãofalsetrueEspecifica se o recurso de descoberta de contêineres deve ser ativado. Este parâmetro é válido apenas quando o Logtail é executado no modo DaemonSet e o caminho do arquivo de coleta é um caminho dentro do contêiner.
ContainerFiltersobjectNãoVazio/As opções de filtragem de contêineres. Várias opções são conectadas pelo operador AND. Este parâmetro é válido apenas quando EnableContainerDiscovery é definido como true.
ContainerFilters.K8sNamespaceRegexstringNãoVaziodefaultPara contêineres implantados em um cluster Kubernetes, a condição de namespace do pod onde o contêiner a ser coletado reside. Se este parâmetro não for adicionado, todos os contêineres serão coletados. A correspondência de expressão regular é suportada.
ContainerFilters.K8sPodRegexstringNãoVaziotest-podPara contêineres implantados em um cluster Kubernetes, a condição de nome do pod onde o contêiner a ser coletado reside. Se este parâmetro não for adicionado, todos os contêineres serão coletados. A correspondência de expressão regular é suportada.
ContainerFilters.IncludeK8sLabelmapNãoVazio/Para contêineres implantados em um cluster Kubernetes, a condição de label do pod onde o contêiner a ser coletado reside. Várias condições são conectadas pelo operador OR. Se este parâmetro não for adicionado, todos os contêineres serão coletados. A correspondência de expressão regular é suportada. A chave no mapa é o nome da label do pod, e o valor é o valor da label do pod. Descrição:
  • Se o valor no mapa estiver vazio, todos os pods que contêm a label com a chave especificada serão correspondidos.

  • Se o valor no mapa não estiver vazio:
    • Se o valor começar com ^ e terminar com $, um pod será correspondido quando a label do pod contiver a chave especificada e o valor da label correspondente corresponder à expressão regular especificada pelo valor.

    • Em outros casos, um pod será correspondido quando a label do pod contiver a chave especificada e o valor especificado.

    ContainerFilters.ExcludeK8sLabelmapNãoVazio/Para contêineres implantados em um cluster Kubernetes, a condição de label do pod onde o contêiner a ser excluído reside. Várias condições são conectadas pelo operador OR. Se este parâmetro não for adicionado, todos os contêineres serão coletados. A correspondência de expressão regular é suportada. A chave no mapa é o nome da label do pod, e o valor é o valor da label do pod. Descrição:
    • Se o valor no mapa estiver vazio, todos os pods que contêm a label com a chave especificada serão correspondidos e excluídos.

    • Se o valor no mapa não estiver vazio:
      • Se o valor começar com ^ e terminar com $, um pod será correspondido e excluído quando a label do pod contiver a chave especificada e o valor da label correspondente corresponder à expressão regular especificada pelo valor.

      • Em outros casos, um pod será correspondido e excluído quando a label do pod contiver a chave especificada e o valor especificado.

      ContainerFilters.K8sContainerRegexstringNãoVaziotest-containerPara contêineres implantados em um cluster Kubernetes, a condição de nome do contêiner a ser coletado. Se este parâmetro não for adicionado, todos os contêineres serão coletados. A correspondência de expressão regular é suportada.
      ContainerFilters.IncludeEnvmapNãoVazio/A condição de variável de ambiente do contêiner a ser coletado. Várias condições são conectadas pelo operador OR. Se este parâmetro não for adicionado, todos os contêineres serão coletados. A correspondência de expressão regular é suportada. A chave no mapa é o nome da variável de ambiente, e o valor é o valor da variável de ambiente. Descrição:
      • Se o valor no mapa estiver vazio, todos os contêineres que contêm a variável de ambiente com a chave especificada serão correspondidos.

      • Se o valor no mapa não estiver vazio:
        • Se o valor começar com ^ e terminar com $, um contêiner será correspondido quando a variável de ambiente do contêiner contiver a chave especificada e o valor da variável de ambiente correspondente corresponder à expressão regular especificada pelo valor.

        • Em outros casos, um contêiner será correspondido quando a variável de ambiente do contêiner contiver a chave especificada e o valor especificado.

        ContainerFilters.ExcludeEnvmapNãoVazio/A condição de variável de ambiente do contêiner a ser excluído. Várias condições são conectadas pelo operador OR. Se este parâmetro não for adicionado, todos os contêineres serão coletados. A correspondência de expressão regular é suportada. A chave no mapa é o nome da variável de ambiente, e o valor é o valor da variável de ambiente. Descrição:
        • Se o valor no mapa estiver vazio, todos os contêineres que contêm a variável de ambiente com a chave especificada serão correspondidos e excluídos.

        • Se o valor no mapa não estiver vazio:
          • Se o valor começar com ^ e terminar com $, um contêiner será correspondido e excluído quando a variável de ambiente do contêiner contiver a chave especificada e o valor da variável de ambiente correspondente corresponder à expressão regular especificada pelo valor.

          • Em outros casos, um contêiner será correspondido e excluído quando a variável de ambiente do contêiner contiver a chave especificada e o valor especificado.

          ContainerFilters.IncludeContainerLabelmapNãoVazio/A condição de label do contêiner a ser coletado. Várias condições são conectadas pelo operador OR. Se este parâmetro não for adicionado, o valor padrão é vazio, o que significa que todos os contêineres serão coletados. A correspondência de expressão regular é suportada. A chave no mapa é o nome da label do contêiner, e o valor é o valor da label do contêiner. Descrição:
          • Se o valor no mapa estiver vazio, todos os contêineres que contêm a label com a chave especificada serão correspondidos.

          • Se o valor no mapa não estiver vazio:
            • Se o valor começar com ^ e terminar com $, um contêiner será correspondido quando a label do contêiner contiver a chave especificada e o valor da label correspondente corresponder à expressão regular especificada pelo valor.

            • Em outros casos, um contêiner será correspondido quando a label do contêiner contiver a chave especificada e o valor especificado.

            ContainerFilters.ExcludeContainerLabelmapNãoVazio/A condição de label do contêiner a ser excluído. Várias condições são conectadas pelo operador OR. Se este parâmetro não for adicionado, o valor padrão é vazio, o que significa que todos os contêineres serão coletados. A correspondência de expressão regular é suportada. A chave no mapa é o nome da label do contêiner, e o valor é o valor da label do contêiner. Descrição:
            • Se o valor no mapa estiver vazio, todos os contêineres que contêm a label com a chave especificada serão correspondidos e excluídos.

            • Se o valor no mapa não estiver vazio:
              • Se o valor começar com ^ e terminar com $, um contêiner será correspondido e excluído quando a label do contêiner contiver a chave especificada e o valor da label correspondente corresponder à expressão regular especificada pelo valor.

              • Em outros casos, um contêiner será correspondido e excluído quando a label do contêiner contiver a chave especificada e o valor especificado.

              ExternalK8sLabelTagmapNãoVazio/Para contêineres implantados em um cluster Kubernetes, as tags relacionadas às labels de pod que precisam ser adicionadas ao log. A chave no mapa é o nome da label do pod, e o valor é o nome da tag correspondente. Por exemplo, se você adicionar app: k8s\_label\_app ao mapa e o pod contiver a label app=serviceA, essas informações serão adicionadas ao log como uma tag, ou seja, o campo __tag__:k8s_label_app: serviceA será adicionado. Se o pod não contiver a label app, um campo vazio __tag__:k8s_label_app: será adicionado.
              ExternalEnvTagmapNãoVazio/Para contêineres implantados em um cluster Kubernetes, as tags relacionadas às variáveis de ambiente do contêiner que precisam ser adicionadas ao log. A chave no mapa é o nome da variável de ambiente, e o valor é o nome da tag correspondente. Por exemplo, se você adicionar VERSION: env\_version ao mapa e o contêiner contiver a variável de ambiente VERSION=v1.0.0, essas informações serão adicionadas ao log como uma tag, ou seja, o campo __tag__:env_version: v1.0.0 será adicionado. Se o contêiner não contiver a variável de ambiente VERSION, um campo vazio __tag__:env_version: será adicionado.
              CollectingContainersMetaboolNãofalsetrueEspecifica se a visualização prévia dos metadados do contêiner deve ser ativada.
              AppendingLogPositionMetaboolNãofalsefalseEspecifica se os metadados do arquivo ao qual o log pertence devem ser adicionados, incluindo o campo __tag__:__inode__ e o campo __file_offset__.
              AllowingIncludedByMultiConfigsboolNãofalsefalseEspecifica se a configuração atual deve ter permissão para coletar arquivos que já foram correspondidos por outras configurações.
              TagsobjectNãoVazio{"FileInodeTagKey":"__inode__"}
              Importante Suportado apenas pelo LoongCollector 3.0.10 e posterior.
              Controla as tags relacionadas à coleta de arquivos. A chave é o nome do parâmetro da tag, e o valor é o nome do campo da tag no log. Quando o valor é default, o valor padrão é usado. Quando o valor é uma string vazia, a tag é excluída. Você pode configurar as seguintes tags:
              • FileInodeTagKey: o inode do arquivo. Não adicionado por padrão. Valor padrão: "__inode__".

              • FilePathTagKey: o caminho do arquivo. Adicionado por padrão. Valor padrão: "__path__".

              Os seguintes parâmetros são válidos apenas quando o parâmetro EnableContainerDiscovery é definido como true.
              • K8sNamespaceTagKey: o namespace do contêiner onde o arquivo reside. Adicionado por padrão. Valor padrão: "_namespace_".

              • K8sPodNameTagKey: o nome do pod onde o arquivo reside. Adicionado por padrão. Valor padrão: "_pod_name_".

              • K8sPodUidTagKey: o UID do pod onde o arquivo reside. Adicionado por padrão. Valor padrão: "_pod_uid_".

              • ContainerNameTagKey: o nome do contêiner onde o arquivo reside. Adicionado por padrão. Valor padrão: "_container_name_".

              • ContainerIpTagKey: o endereço IP do contêiner onde o arquivo reside. Adicionado por padrão. Valor padrão: "_container_ip_".

              • ContainerImageNameTagKey: a imagem do contêiner onde o arquivo reside. Adicionado por padrão. Valor padrão: "_image_name_".

              FileOffsetKeystringNãoVazio__file_offset__
              Importante Suportado apenas pelo LoongCollector 3.0.10 e posterior.
              A tag para a posição do log no arquivo. Não adicionada por padrão. Valor padrão: __file_offset__. Quando o valor é __default__, o valor padrão é usado. Quando o valor é uma string vazia, a tag é excluída. Quando o parâmetro EnableLogPositionMeta e o parâmetro Tags.FileInodeTagKey ou FileOffsetKey existem ao mesmo tempo, o parâmetro EnableLogPositionMeta é ignorado.

              Saída padrão do contêiner (legado)

              ParâmetroTipoObrigatórioValor padrãoExemploDescrição
              TypestringSim/service_docker_stdoutO tipo de plug-in. Defina o valor como service_docker_stdout.
              StdoutBooleanNãotruetrueEspecifica se a saída padrão (stdout) deve ser coletada.
              StderrBooleanNãotruetrueEspecifica se o erro padrão (stderr) deve ser coletado.
              StartLogMaxOffsetIntegerNão128×1024131072O comprimento dos dados históricos a serem rastreados durante a primeira coleta. Unidade: bytes. Recomendamos que você defina o valor como um número no intervalo de [131072, 1048576].
              IncludeLabelMap, onde LabelKey e LabelValue são do tipo StringNãoVazio

              A lista de permissão de labels de contêiner, que é usada para especificar os contêineres a serem coletados. O valor padrão é vazio, o que significa que a saída padrão de todos os contêineres é coletada. Se você quiser definir uma lista de permissão de labels de contêiner, LabelKey é obrigatório e LabelValue é opcional.

              • Se LabelValue estiver vazio, todos os contêineres cujas labels contêm LabelKey serão correspondidos.

              • Se LabelValue não estiver vazio, apenas os contêineres cujas labels contêm LabelKey=LabelValue serão correspondidos.

                Por padrão, LabelValue usa correspondência de string, o que significa que uma correspondência ocorre apenas quando LabelValue é exatamente igual ao valor da label do contêiner. Se o valor começar com ^ e terminar com $, a correspondência de expressão regular será usada. Por exemplo, se LabelKey for definido como io.kubernetes.container.name e LabelValue for definido como ^(nginx|cube)$, os contêineres chamados nginx ou cube serão correspondidos.

              Várias listas de permissão são conectadas pelo operador OR, o que significa que um contêiner é correspondido desde que suas labels atendam a qualquer uma das listas de permissão.

              ExcludeLabelMap, onde LabelKey e LabelValue são do tipo StringNãoVazio

              A lista de exclusão de labels de contêiner, que é usada para excluir os contêineres que não precisam ser coletados. O valor padrão é vazio, o que significa que nenhum contêiner é excluído. Se você quiser definir uma lista de exclusão de labels de contêiner, LabelKey é obrigatório e LabelValue é opcional.

              • Se LabelValue estiver vazio, todos os contêineres cujas labels contêm LabelKey serão excluídos.

              • Se LabelValue não estiver vazio, apenas os contêineres cujas labels contêm LabelKey=LabelValue serão excluídos.

                Por padrão, LabelValue usa correspondência de string, o que significa que uma correspondência ocorre apenas quando LabelValue é exatamente igual ao valor da label do contêiner. Se o valor começar com ^ e terminar com $, a correspondência de expressão regular será usada. Por exemplo, se LabelKey for definido como io.kubernetes.container.name e LabelValue for definido como ^(nginx|cube)$, os contêineres chamados nginx ou cube serão correspondidos e excluídos.

              Várias listas de exclusão são conectadas pelo operador OR, o que significa que um contêiner é excluído desde que suas labels atendam a qualquer uma das listas de exclusão.

              IncludeEnvMap, onde EnvKey e EnvValue são do tipo StringNãoVazio

              A lista de permissão de variáveis de ambiente, que é usada para especificar os contêineres a serem coletados. O valor padrão é vazio, o que significa que a saída padrão de todos os contêineres é coletada. Se você quiser definir uma lista de permissão de variáveis de ambiente, EnvKey é obrigatório e EnvValue é opcional.

              • Se EnvValue estiver vazio, todos os contêineres cujas variáveis de ambiente contêm EnvKey serão correspondidos.

              • Se EnvValue não estiver vazio, apenas os contêineres cujas variáveis de ambiente contêm EnvKey=EnvValue serão correspondidos.

                Por padrão, EnvValue usa correspondência de string, o que significa que uma correspondência ocorre apenas quando EnvValue é exatamente igual ao valor da variável de ambiente. Se o valor começar com ^ e terminar com $, a correspondência de expressão regular será usada. Por exemplo, se EnvKey for definido como NGINX_SERVICE_PORT e EnvValue for definido como `^(80

              ExcludeEnvMap, onde EnvKey e EnvValue são do tipo StringNãoVazio

              A lista de exclusão de variáveis de ambiente, que é usada para excluir os contêineres que não precisam ser coletados. O valor padrão é vazio, o que significa que nenhum contêiner é excluído. Se você quiser definir uma lista de exclusão de variáveis de ambiente, EnvKey é obrigatório e EnvValue é opcional.

              • Se EnvValue estiver vazio, os logs de todos os contêineres cujas variáveis de ambiente contêm EnvKey serão excluídos.

              • Se EnvValue não estiver vazio, apenas os contêineres cujas variáveis de ambiente contêm EnvKey=EnvValue serão excluídos.

                Por padrão, EnvValue usa correspondência de string, o que significa que uma correspondência ocorre apenas quando EnvValue é exatamente igual ao valor da variável de ambiente. Se o valor começar com ^ e terminar com $, a correspondência de expressão regular será usada. Por exemplo, se EnvKey for definido como NGINX_SERVICE_PORT e EnvValue for definido como ^(80|6379)$, os contêineres cuja porta de serviço é 80 ou 6379 serão correspondidos e excluídos.

              Várias listas de exclusão são conectadas pelo operador OR, o que significa que um contêiner é excluído desde que suas variáveis de ambiente atendam a qualquer um dos pares chave-valor.

              IncludeK8sLabelMap, onde LabelKey e LabelValue são do tipo StringNãoVazio

              A lista de permissão de labels do Kubernetes (definidas em template.metadata), que é usada para especificar os contêineres a serem coletados. Se você quiser definir uma lista de permissão de labels do Kubernetes, LabelKey é obrigatório e LabelValue é opcional.

              • Se LabelValue estiver vazio, todos os contêineres cujas labels do Kubernetes contêm LabelKey serão correspondidos.

              • Se LabelValue não estiver vazio, apenas os contêineres cujas labels do Kubernetes contêm LabelKey=LabelValue serão correspondidos.

                Por padrão, LabelValue usa correspondência de string, o que significa que uma correspondência ocorre apenas quando LabelValue é exatamente igual ao valor da label do Kubernetes. Se o valor começar com ^ e terminar com $, a correspondência de expressão regular será usada. Por exemplo, se LabelKey for definido como app e LabelValue for definido como ^(test1|test2)$, os contêineres cujas labels do Kubernetes contêm app:test1 ou app:test2 serão correspondidos.

              Várias listas de permissão são conectadas pelo operador OR, o que significa que um contêiner é correspondido desde que suas labels do Kubernetes atendam a qualquer uma das listas de permissão.

              ExcludeK8sLabelMap, onde LabelKey e LabelValue são do tipo StringNãoVazio

              A lista de exclusão de labels do Kubernetes (definidas em template.metadata), que é usada para excluir os contêineres que não precisam ser coletados. Se você quiser definir uma lista de exclusão de labels do Kubernetes, LabelKey é obrigatório e LabelValue é opcional.

              • Se LabelValue estiver vazio, todos os contêineres cujas labels do Kubernetes contêm LabelKey serão excluídos.

              • Se LabelValue não estiver vazio, apenas os contêineres cujas labels do Kubernetes contêm LabelKey=LabelValue serão excluídos.

                Por padrão, LabelValue usa correspondência de string, o que significa que uma correspondência ocorre apenas quando LabelValue é exatamente igual ao valor da label do Kubernetes. Se o valor começar com ^ e terminar com $, a correspondência de expressão regular será usada. Por exemplo, se LabelKey for definido como app e LabelValue for definido como ^(test1|test2)$, os contêineres cujas labels do Kubernetes contêm app:test1 ou app:test2 serão correspondidos e excluídos.

              Várias listas de exclusão são conectadas pelo operador OR, o que significa que um contêiner é excluído desde que suas labels do Kubernetes atendam a qualquer uma das listas de exclusão.

              K8sNamespaceRegexStringNãoVazio^(default|nginx)$Especifica os contêineres a serem coletados pelo nome do namespace. A correspondência de expressão regular é suportada. Por exemplo, se você definir o valor como ^(default|nginx)$, todos os contêineres nos namespaces nginx e default serão correspondidos.
              K8sPodRegexStringNãoVazio^(nginx-log-demo.*)$Especifica os contêineres a serem coletados pelo nome do pod. A correspondência de expressão regular é suportada. Por exemplo, se você definir o valor como ^(nginx-log-demo.*)$, todos os contêineres nos pods cujos nomes começam com nginx-log-demo serão correspondidos.
              K8sContainerRegexStringNãoVazio^(container-test)$Especifica os contêineres a serem coletados pelo nome do contêiner (o nome do contêiner Kubernetes é definido em spec.containers). A correspondência de expressão regular é suportada. Por exemplo, se você definir o valor como ^(container-test)$, todos os contêineres chamados container-test serão correspondidos.

              Parâmetros de processamento de dados

              ParâmetroTipoObrigatórioValor padrãoExemploDescrição
              BeginLineRegexStringNãoVazio

              A expressão regular usada para corresponder à primeira linha de um log.

              Se este parâmetro estiver vazio, o modo de linha única será usado.

              Se a expressão corresponder ao início de uma linha, a linha será tratada como um novo log. Caso contrário, a linha será concatenada ao log anterior.

              BeginLineCheckLengthIntegerNãoVazio

              O comprimento da primeira linha a ser correspondida. Unidade: bytes.

              O valor padrão é 10 × 1024 bytes.

              Se a expressão regular para correspondência da primeira linha puder ser refletida nos primeiros N bytes, recomendamos que você defina este parâmetro para melhorar a eficiência da correspondência.

              BeginLineTimeoutMsIntegerNãoVazio

              O período de tempo limite para a correspondência da primeira linha. Unidade: milissegundos.

              O valor padrão é 3000 milissegundos.

              Se nenhum novo log aparecer dentro de 3000 milissegundos, a correspondência termina e o último log é carregado no Simple Log Service.

              MaxLogSizeIntegerNãoVazio

              O comprimento máximo de um log. O valor padrão é 0. Unidade: bytes.

              O valor padrão é 512 × 1024 bytes.

              Se o comprimento do log exceder este valor, o sistema para de procurar a primeira linha e carrega o log diretamente.

              ExternalK8sLabelTagMap, onde LabelKey e LabelValue são do tipo StringNãoVazio

              Depois de definir as tags de log para os rótulos do Kubernetes (definidos em template.metadata), o Logtail adiciona campos relacionados aos rótulos do Kubernetes ao log.

              Por exemplo, se você definir LabelKey como app e LabelValue como k8s_label_app, quando um pod contiver o rótulo app=serviceA, o Logtail adicionará essas informações ao log, ou seja, o campo k8s_label_app: serviceA será adicionado. Se o pod não contiver o rótulo app, um campo vazio k8s_label_app: será adicionado.

              ExternalEnvTagMap, onde EnvKey e EnvValue são do tipo StringNãoVazio

              Depois de definir as tags de log para as variáveis de ambiente do contêiner, o Logtail adiciona campos relacionados às variáveis de ambiente do contêiner ao log.

              Por exemplo, se você definir EnvKey como VERSION e EnvValue como env_version, quando um contêiner contiver a variável de ambiente VERSION=v1.0.0, essas informações serão adicionadas ao log como uma tag, ou seja, o campo env_version: v1.0.0 será adicionado. Se o contêiner não contiver a variável de ambiente VERSION, um campo vazio env_version: será adicionado.

              Elementos de resposta

              Elemento

              Tipo

              Descrição

              Exemplo

              Nenhum definido.

              Exemplos

              Resposta de sucesso

              JSON formato

              {}

              Códigos de erro

              Consulte Códigos de Erro para uma lista completa.

              Notas de versão

              Consulte Notas de Versão para uma lista completa.