Modelo para implantar o Agente de criação de log usando um gráfico Helm em um cluster Openshift

metadata:
  name: "logs-agent"
image:
  version: "1.3.0"  # required

clusterName: ""     # Enter the name of your cluster. This information is used to improve the metadata and help with your filtering.

env:
  # ingestionHost is a required field. For example:
  # ingestionHost: "<logs instance>.ingress.us-east.logs.cloud.ibm.com"
  ingestionHost: "" # required

  # If you are using private CSE proxy, then use port number "3443"
  # If you are using private VPE Gateway, then use port number "443"
  # If you are using the public endpoint, then use port number "443"
  ingestionPort: "" # required

  iamMode: "TrustedProfile"
  # trustedProfileID - trusted profile id - required if iamMode is set to "TrustedProfile"
  trustedProfileID: ""

  # Configure this parameter to control the IAM endpoint used by the agent to exchange the tokens.
  # If omitted, the default value is "Production".
  # Valid values are :
  # "Production" to use the iam.cloud.ibm.com default endpoint
  # "PrivateProduction" to use the private.iam.cloud.ibm.com endpoint
  # "Custom" to use a custom provided IAM endpoint
  iamEnvironment: "Production"
  # iamHost - custom IAM endpoint (for example: private.eu-de.iam.cloud.ibm.com) - required if iamEnvironment is set to "Custom"
  iamHost: ""

scc:
  # true enables creation of Security Context Constraints in Openshift clusters
  create: true

defaultMetadata:
  # Configure to override the default subsystemName and applicationName that are used in the environment.
  subsystemName: ""  # The default value is set to the namespace that generated the log
  applicationName: ""  # The default value is set to the container name that generated the log

resources:
  # Configure this section to change the resources that are assigned to the agent container.
  limits:
    cpu: 500m
    ephemeral_storage: 10Gi
    memory: 3Gi
  requests:
    cpu: 100m
    ephemeral_storage: 2Gi
    memory: 1Gi

# Configure these parameters to include, exclude or restrict the set of logs that are processed by the agent
# By default, the agent will collect the logs from `/var/log/containers/*.log`.
# Each field is set as comma separated list, for example “/var/log/abc/*.log,/var/log/xyz/*.log”
additionalLogSourcePaths: "" # adds locations to the default set of logs that will be processed.
excludeLogSourcePaths: "" # ignores logs in the specified locations.
selectedLogSourcePaths: ""  # overrides the default path `/var/log/containers/*.log` and ignores the `additionalLogSourcePaths` configurations

# Configure this parameter to change the setting for the Kubernetes filter to include the annotations from Kubernetes with the log records.
# The default value for this setting is `false`.
includeAnnotations: true

# Configure this parameter to control the number of times the agent will retry sending data if an error occurs that is considered to be retryable.
# The default is `False`.
# For more information, see the [Fluentbit documentation about retries](https://docs.fluentbit.io/manual/administration/scheduling-and-retries) to understand the implications of setting this value.
retryLimit: False

# Configure additional tags as key/value pair tags that can be added as metadata to every log line.
additionalMetadata:
#  region: ca-tor
#  env: production

# Configure the level of logging
# Default value is info
# Valid values are: debug, info, or error
loggingLevel: info

Modelo para implantar o Agente de criação de log usando um gráfico Helm em um cluster Kubernetes

metadata:
  name: "logs-agent"
image:
  version: "1.3.0"  # required

clusterName: ""     # Enter the name of your cluster. This information is used to improve the metadata and help with your filtering.

env:
  # ingestionHost is a required field. For example:
  # ingestionHost: "<logs instance>.ingress.us-east.logs.cloud.ibm.com"
  ingestionHost: "" # required

  # If you are using private CSE proxy, then use port number "3443"
  # If you are using private VPE Gateway, then use port number "443"
  # If you are using the public endpoint, then use port number "443"
  ingestionPort: "" # required

  iamMode: "TrustedProfile"
  # trustedProfileID - trusted profile id - required for iam trusted profile mode
  trustedProfileID: "" # required if iamMode is set to TrustedProfile

  # Configure this parameter to control the IAM endpoint used by the agent to exchange the tokens.
  # If omitted, the default value is "Production".
  # Valid values are :
  # "Production" to use the iam.cloud.ibm.com default endpoint
  # "PrivateProduction" to use the private.iam.cloud.ibm.com endpoint
  # "Custom" to use a custom provided IAM endpoint
  iamEnvironment: "Production"
  # iamHost - custom IAM endpoint (for example: private.eu-de.iam.cloud.ibm.com) - required if iamEnvironment is set to "Custom"
  iamHost: ""

scc:
  # true enables creation of Security Context Constraints in Openshift clusters
  # set to false for Kubernetes clusters
  create: false

defaultMetadata:
  # Configure to override the default subsystemName and applicationName that are used in the environment.
  subsystemName: ""  # The default value is set to the namespace that generated the log
  applicationName: ""  # The default value is set to the container name that generated the log

resources:
  # Configure this section to change the resources that are assigned to the agent container.
  limits:
    cpu: 500m
    ephemeral_storage: 10Gi
    memory: 3Gi
  requests:
    cpu: 100m
    ephemeral_storage: 2Gi
    memory: 1Gi

# Configure these parameters to include, exclude or restrict the set of logs that are processed by the agent
# By default, the agent will collect the logs from `/var/log/containers/*.log`.
# Each field is set as comma separated list, for example “/var/log/abc/*.log,/var/log/xyz/*.log”
additionalLogSourcePaths: "" # adds locations to the default set of logs that will be processed.
excludeLogSourcePaths: "" # ignores logs in the specified locations.
selectedLogSourcePaths: ""  # overrides the default path `/var/log/containers/*.log` and ignores the `additionalLogSourcePaths` configurations

# Configure this parameter to change the setting for the Kubernetes filter to include the annotations from Kubernetes with the log records.
# The default value for this setting is `false`.
includeAnnotations: true

# Configure this parameter to control the number of times the agent will retry sending data if an error occurs that is considered to be retryable.
# The default is `False`.
# For more information, see the [Fluentbit documentation about retries](https://docs.fluentbit.io/manual/administration/scheduling-and-retries) to understand the implications of setting this value.
retryLimit: False

# Configure additional tags as key/value pair tags that can be added as metadata to every log line.
additionalMetadata:
#  region: ca-tor
#  env: production

# Configure the level of logging
# Default value is info
# Valid values are: debug, info, or error
loggingLevel: info

Helm Opções de configuração do gráfico

A tabela a seguir contém uma lista dos parâmetros que você pode configurar no arquivo logs-values.yaml para ajustar as configurações de Agente de criação de log:

env.iamMode

Configure esse parâmetro para escolher o método de autenticação a ser usado pelo agente ao enviar registros para uma instância de IBM Cloud Logs.

• Você pode escolher uma APIKey do IAM ou uma configuração de perfil confiável.
• Os valores válidos são: TrustedProfile ou IAMAPIKey
• O valor padrão é uma configuração de perfil confiável.

A entrada no arquivo logs-values.yaml tem a seguinte aparência:

env:
  iamMode: IAMAPIKey

Considere as seguintes informações ao definir esse parâmetro:

• Se env.iamMode: "TrustedProfile" for definido, a variável env.trustedProfileID também deverá ser fornecida.

• Se env.iamMode: "IAMAPIKey" for definido, a configuração espera que seja definido um segredo que contenha uma Apikey do IAM com permissões.

  Se a variável secret.iamAPIKey for fornecida no comando helm (por exemplo, --set secret.iamAPIKey=<your iamAPIKey>), o gráfico helm criará o segredo Kubernetes.

  Como alternativa, você pode criar o segredo antecipadamente com o comando: (Certifique-se de estar conectado ao seu cluster)

  kubectl create secret generic <helm install-name> -n ibm-observe --from-literal=IAM_API_KEY=<apikey>
  

defaultMetadata

Essa seção permite que o usuário substitua o subsystemName e o applicationName padrão que são usados no ambiente. Por padrão, os valores não são definidos e o plug-in de saída definirá dinamicamente os valores para:

• subsystemName: o namespace Kubernetes que gerou o registro
• applicationName: o nome do contêiner que gerou o registro

A entrada no arquivo logs-values.yaml tem a seguinte aparência:

defaultMetadata:
  subsystemName: ""
  applicationName: ""

recursos

Esta seção permite que o usuário altere os recursos que são atribuídos ao contêiner Agente de criação de log.

A entrada no arquivo logs-values.yaml tem a seguinte aparência e define os seguintes valores padrão:

resources:
  limits:
    cpu: 500m
    ephemeral_storage: 10Gi
    memory: 3Gi
  requests:
    cpu: 100m
    ephemeral_storage: 2Gi
    memory: 1Gi

Se você precisar atualizar qualquer um dos valores, toda a configuração deverá ser fornecida, mesmo que você não atualize todos os valores.

Configurações de caminhos de origem de registro

Por padrão, o agente coletará os registros de /var/log/containers/*.log.

As seguintes variáveis adicionais podem ser fornecidas para incluir, excluir ou restringir o conjunto de registros a serem processados:

• additionalLogSourcePaths adiciona locais ao conjunto padrão de registros que serão processados.
• excludeLogSourcePaths ignora os registros nos locais especificados.
• selectedLogSourcePaths substitui o caminho padrão /var/log/containers/*.log e ignora as configurações additionalLogSourcePaths. Somente os arquivos definidos por meio desse parâmetro são coletados pelo agente.

Você pode definir vários caminhos usando uma lista separada por vírgulas, por exemplo, "/var/log/abc/.log,/var/log/xyz/.log".

A entrada no arquivo logs-values.yaml tem a seguinte aparência:

# comma separated list, for example “/var/log/abc/*.log,/var/log/xyz/*.log”
additionalLogSourcePaths: ""
excludeLogSourcePaths: ""
selectedLogSourcePaths: ""

env.iamEnvironment

Essa configuração controla o ponto de extremidade do IAM usado pelo agente para trocar os tokens.

O valor padrão é Production.

Os valores válidos são :

• Defina Production para usar o endpoint padrão iam.cloud.ibm.com
• Defina PrivateProduction para usar o ponto de extremidade private.iam.cloud.ibm.com
• Defina Custom para usar um endpoint IAM personalizado (por exemplo, private.eu-de.iam.cloud.ibm.com )

A entrada no arquivo logs-values.yaml tem a seguinte aparência:

env:
  iamEnvironment: "Production"

Para a configuração Custom iamEnvironment, o iamHost também deve ser fornecido.

env:
  iamEnvironment: "Custom"
  iamHost: "private.eu-de.iam.cloud.ibm.com"

includeAnnotations

Essa configuração altera a definição do filtro Kubernetes para incluir as anotações de Kubernetes com os registros de log.

O valor padrão para essa configuração é false.

A entrada no arquivo logs-values.yaml tem a seguinte aparência:

includeAnnotations: true

retryLimit

Essa configuração coloca um limite no número de vezes que o agente tentará enviar dados novamente se ocorrer um erro que seja considerado passível de nova tentativa.

O padrão é False.

Para obter mais informações, consulte a documentação do Fluentbit sobre tentativas para entender as implicações da definição desse valor.

Em algumas situações, essa configuração pode fazer com que os dados de registro sejam descartados pelo agente devido à incapacidade de envio.

A entrada no arquivo logs-values.yaml tem a seguinte aparência:

retryLimit: 8

additionalMetadata

Essa é uma lista de pares de chave/valor que serão adicionados ao objeto meta para permitir tags adicionais.

A entrada no arquivo logs-values.yaml tem a seguinte aparência:

additionalMetadata:
  region: ca-tor
  env: production

O exemplo acima resultará nos seguintes campos adicionais adicionados a cada linha de registro em IBM Cloud Logs:

{
  "meta": {
    "region": "ca-tor",
    "env": "production"
  }
}