> ## Documentation Index > Fetch the complete documentation index at: https://docs.appsignal.com/llms.txt > Use this file to discover all available pages before exploring further. # Opções de configuração do pacote Python A lista a seguir inclui todas as opções de configuração com o nome da variável de ambiente e o nome da chave no arquivo de configuração. Para mais informações sobre como configurar o AppSignal com um arquivo de configuração ou variáveis de ambiente do sistema, consulte nossa documentação de [Configuração](/python/configuration). ## Opções disponíveis * Opções obrigatórias * [`active`](#option-active) * [`environment`](#option-environment) * [`name`](#option-name) * [`push_api_key`](#option-push_api_key) * Opções * [`bind_address`](#option-bind_address) * [`ca_file_path`](#option-ca_file_path) * [`collector_endpoint`](#option-collector_endpoint) * [`cpu_count`](#option-cpu_count) * [`disable_default_instrumentations`](#option-disable_default_instrumentations) * [`dns_servers`](#option-dns_servers) * [`enable_host_metrics`](#option-enable_host_metrics) * [`enable_minutely_probes`](#option-enable_minutely_probes) * [`enable_nginx_metrics`](#option-enable_nginx_metrics) * [`enable_statsd`](#option-enable_statsd) * [`endpoint`](#option-endpoint) * [`files_world_accessible`](#option-files_world_accessible) * [`filter_attributes`](#option-filter_attributes) * [`filter_function_parameters`](#option-filter_function_parameters) * [`filter_parameters`](#option-filter_parameters) * [`filter_request_payload`](#option-filter_request_payload) * [`filter_request_query_parameters`](#option-filter_request_query_parameters) * [`filter_session_data`](#option-filter_session_data) * [`host_role`](#option-host_role) * [`hostname`](#option-hostname) * [`http_proxy`](#option-http_proxy) * [`ignore_actions`](#option-ignore_actions) * [`ignore_errors`](#option-ignore_errors) * [`ignore_namespaces`](#option-ignore_namespaces) * [`log`](#option-log) * [`log_level`](#option-log_level) * [`log_path`](#option-log_path) * [`nginx_port`](#option-nginx_port) * [`opentelemetry_port`](#option-opentelemetry_port) * [`request_headers`](#option-request_headers) * [`response_headers`](#option-response_headers) * [`revision`](#option-revision) * [`running_in_container`](#option-running_in_container) * [`send_environment_metadata`](#option-send_environment_metadata) * [`send_function_parameters`](#option-send_function_parameters) * [`send_params`](#option-send_params) * [`send_request_payload`](#option-send_request_payload) * [`send_request_query_parameters`](#option-send_request_query_parameters) * [`send_session_data`](#option-send_session_data) * [`service_name`](#option-service_name) * [`statsd_port`](#option-statsd_port) * [`working_directory_path`](#option-working_directory_path) ## active | Campo | Valor | | ---------------------------------------- | -------------------------- | | Chave do arquivo de configuração | `active` | | Chave de variável de ambiente do sistema | `APPSIGNAL_ACTIVE` | | Obrigatório | sim | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `false` | | Disponível desde a versão | `0.1.0` | ### Descrição Configura se o AppSignal está ativo ou não para um determinado ambiente. Se o AppSignal não estiver ativo, nenhum dado é reportado para o aplicativo no ambiente especificado. ## environment | Campo | Valor | | ---------------------------------------- | ------------------- | | Chave do arquivo de configuração | `environment` | | Chave de variável de ambiente do sistema | `APPSIGNAL_APP_ENV` | | Obrigatório | sim | | Tipo | `String` | | Valor padrão | `development` | | Disponível desde a versão | `0.1.0` | ### Descrição O ambiente do aplicativo que será reportado ao AppSignal. **Observação**: alterar o [nome](#option-name) ou o ambiente de um aplicativo existente criará um novo aplicativo no AppSignal.com. ## name | Campo | Valor | | ---------------------------------------- | ----------------------------- | | Chave do arquivo de configuração | `name` | | Chave de variável de ambiente do sistema | `APPSIGNAL_APP_NAME` | | Obrigatório | sim | | Tipo | `String` | | Valor padrão | nil (não definido por padrão) | | Disponível desde a versão | `0.1.0` | ### Descrição Nome do seu aplicativo como deve ser exibido no AppSignal.com. **Observação**: alterar o nome ou o [ambiente](#option-env) de um aplicativo existente criará um novo aplicativo no AppSignal.com. ## push\_api\_key | Campo | Valor | | ---------------------------------------- | ----------------------------- | | Chave do arquivo de configuração | `push_api_key` | | Chave de variável de ambiente do sistema | `APPSIGNAL_PUSH_API_KEY` | | Obrigatório | sim | | Tipo | `String` | | Valor padrão | nil (não definido por padrão) | | Disponível desde a versão | `0.1.0` | ### Descrição A chave de autenticação no nível da organização para autenticar-se com a nossa Push API. Leia mais sobre a [chave Push API do AppSignal](/appsignal/terminology#push-api-key). ## bind\_address | Campo | Valor | | ---------------------------------------- | ------------------------ | | Chave do arquivo de configuração | `bind_address` | | Chave de variável de ambiente do sistema | `APPSIGNAL_BIND_ADDRESS` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | `127.0.0.1` | | Disponível desde a versão | `0.1.5` | ### Descrição Um endereço IPv4 válido que o agente do AppSignal usa como vínculo para seus servidores TCP e UDP. Use um endereço específico se quiser que o agente escute apenas as requisições feitas para esse endereço. Defina esta opção como `0.0.0.0` para permitir o recebimento de requisições de hosts usando qualquer endereço IP. Por padrão, ele escuta apenas as requisições feitas no mesmo host. Esta opção é aplicada a todos os servidores do agente ([StatsD](#option-enable_statsd), [OpenTelemetry](#option-enable_opentelemetry_http) e [NGINX](#option-enable_nginx_metrics)). **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## ca\_file\_path | Campo | Valor | | ---------------------------------------- | ------------------------------------------- | | Chave do arquivo de configuração | `ca_file_path` | | Chave de variável de ambiente do sistema | `APPSIGNAL_CA_FILE_PATH` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | Caminho do arquivo `cacert.pem` empacotado. | | Disponível desde a versão | `0.1.0` | ### Descrição Use esta opção para apontar para outro arquivo de certificado se houver um problema ao conectar-se à nossa API. **Nota**: O caminho especificado não pode conter abstrações de sistema de arquivos específicas do sistema operacional, como o símbolo de diretório home `~` para sistemas \*NIX. Isso será visto como um caminho malformado. Ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito sobre como a integração se comunica com o coletor externo. Ela ainda será usada na comunicação com os servidores da AppSignal. ## collector\_endpoint | Campo | Valor | | ---------------------------------------- | ------------------------------ | | Chave do arquivo de configuração | `collector_endpoint` | | Chave de variável de ambiente do sistema | `APPSIGNAL_COLLECTOR_ENDPOINT` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | nil (Não definido por padrão) | | Disponível desde a versão | `1.6.0` | ### Descrição O endereço de um [AppSignal Collector](/collector) implantado externamente. Quando definido, o agente do AppSignal incluído na integração não será usado, e os dados do OpenTelemetry serão enviados para o coletor neste endereço. Esta é uma opção de configuração **experimental**. As seguintes funcionalidades **não estarão disponíveis** ao usar um coletor externo: * [Métricas do NGINX](/metrics/nginx) * [Métricas de host](/metrics/host-metrics) * [Métricas do StatsD](/standalone-agent/statsd) As seguintes funcionalidades estão **disponíveis apenas** ao usar um coletor externo: * [Logging](/logging) ## cpu\_count | Campo | Valor | | ---------------------------------------- | --------------------- | | Chave do arquivo de configuração | `cpu_count` | | Chave de variável de ambiente do sistema | `APPSIGNAL_CPU_COUNT` | | Obrigatório | não | | Tipo | `Float` | | Valor padrão | `undefined` | | Disponível desde a versão | `1.2.0` | ### Descrição A capacidade de CPU disponível do host, em número de CPUs. Isso é usado para calcular a porcentagem de uso de CPU nas métricas do host. Se não for definido, o agente tentará detectar isso automaticamente a partir do cgroups. O número de CPUs pode ser uma fração, por exemplo, `0.5`. **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## disable\_default\_instrumentations | Campo | Valor | | ---------------------------------------- | -------------------------------------------- | | Chave do arquivo de configuração | `disable_default_instrumentations` | | Chave de variável de ambiente do sistema | `APPSIGNAL_DISABLE_DEFAULT_INSTRUMENTATIONS` | | Obrigatório | não | | Tipo | `list(String)` ou Boolean (`true` / `false`) | | Valor padrão | `false` | | Disponível desde a versão | `0.1.0` | ### Descrição Permite que você desative a instrumentação automática das integrações padrão: * `aiopg` * `asyncpg` * `celery` * `django` * `flask` * `mysql` * `mysqlclient` * `psycopg` * `psycopg2` * `pymysql` * `redis` * `jinja2` * `requests` * `sqlalchemy` * `sqlite3` * `logging` Ao usar o AppSignal para Python 1.5.4 ou anterior, prefixe cada um desses nomes com `opentelemetry.instrumentation.`. Por exemplo, `jinja2` seria especificado como `opentelemetry.instrumentation.jinja2`. Observe que as instrumentações só são habilitadas se a biblioteca de instrumentação correspondente do OpenTelemetry estiver instalada. Para desativar todas as instrumentações automáticas, defina o valor como `True`. ## dns\_servers | Campo | Valor | | ---------------------------------------- | ----------------------- | | Chave do arquivo de configuração | `dns_servers` | | Chave de variável de ambiente do sistema | `APPSIGNAL_DNS_SERVERS` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `0.1.0` | ### Descrição Configura os servidores DNS que o agente do AppSignal deve usar. ```sh Shell theme={null} # No ambiente do host export APPSIGNAL_DNS_SERVERS="8.8.8.8,8.8.4.4" ``` Se você é afetado pelos nossos [timeouts de DNS](/support/known-issues#dns-timeouts), tente definir um servidor DNS manualmente usando esta opção que não utilize mais de **4** pontos no nome do servidor. * Valores aceitáveis: `8.8.8.8`, `my.custom.local.server`. * Valores não aceitáveis: `foo`, `my.awesome.custom.local.dns.server`. Se o servidor DNS não puder ser alcançado, o agente recorrerá à configuração de DNS do host e gerará uma mensagem no arquivo `appsignal.log`: `A problem occurred while setting DNS servers`. **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## enable\_host\_metrics | Campo | Valor | | ---------------------------------------- | ----------------------------------- | | Chave do arquivo de configuração | `enable_host_metrics` | | Chave de variável de ambiente do sistema | `APPSIGNAL_ENABLE_HOST_METRICS` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | \`\`true` / detectado pelo sistema` | | Disponível desde a versão | `0.1.0` | ### Descrição Defina esta opção como `false` para desativar a coleta de [métricas do host](/metrics/host-metrics). No Heroku e no Dokku, as métricas do host estão desativadas por padrão. Isso é feito porque esses sistemas relatam métricas imprecisas a partir dos containers. A coleta de métricas de host nesses sistemas não pode ser habilitada. Para o Heroku, utilize o [Heroku log drain](/heroku/host-metrics). **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## enable\_minutely\_probes | Campo | Valor | | ---------------------------------------- | ---------------------------------- | | Chave do arquivo de configuração | `enable_minutely_probes` | | Chave de variável de ambiente do sistema | `APPSIGNAL_ENABLE_MINUTELY_PROBES` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `true` | | Disponível desde a versão | `1.2.0` | ### Descrição Habilita o sistema de [probes minutados](/python/instrumentation/minutely-probes). ## enable\_nginx\_metrics | Campo | Valor | | ---------------------------------------- | -------------------------------- | | Chave do arquivo de configuração | `enable_nginx_metrics` | | Chave de variável de ambiente do sistema | `APPSIGNAL_ENABLE_NGINX_METRICS` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `false` | | Disponível desde a versão | `0.1.0` | ### Descrição Defina como `true` para habilitar o servidor de métricas do NGINX. [Consulte a documentação de métricas do NGINX para mais detalhes.](/metrics/nginx) Quando habilitado, o agente do AppSignal escutará um servidor vinculado a `localhost` na porta 27649. Se você estiver executando vários aplicativos instrumentados pelo AppSignal no mesmo servidor, essa opção de configuração só pode ser habilitada em um deles. **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## enable\_statsd | Campo | Valor | | ---------------------------------------- | -------------------------- | | Chave do arquivo de configuração | `enable_statsd` | | Chave de variável de ambiente do sistema | `APPSIGNAL_ENABLE_STATSD` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `false` | | Disponível desde a versão | `0.1.0` | ### Descrição Habilita o [servidor StatsD](/standalone-agent/statsd) no agente do AppSignal. Quando habilitado, o agente do AppSignal escutará um servidor vinculado a `localhost` na porta 8125. Se você estiver executando vários aplicativos instrumentados pelo AppSignal no mesmo servidor, essa opção de configuração só pode ser habilitada em um deles. **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## endpoint | Campo | Valor | | ---------------------------------------- | ----------------------------- | | Chave do arquivo de configuração | `endpoint` | | Chave de variável de ambiente do sistema | `APPSIGNAL_PUSH_API_ENDPOINT` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | `https://push.appsignal.com` | | Disponível desde a versão | `0.1.0` | ### Descrição Configura o endpoint para o qual os dados serão enviados ao AppSignal. Essa configuração não precisará ser alterada. **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## files\_world\_accessible | Campo | Valor | | ---------------------------------------- | ---------------------------------- | | Chave do arquivo de configuração | `files_world_accessible` | | Chave de variável de ambiente do sistema | `APPSIGNAL_FILES_WORLD_ACCESSIBLE` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `true` | | Disponível desde a versão | `0.1.0` | ### Descrição Se isso for definido como `true`, o [diretório de trabalho do AppSignal](/appsignal/how-appsignal-operates#working-directory) criado fica acessível a todos os usuários (permissões Unix `0666`). Isso é frequentemente necessário porque processos do mesmo aplicativo são executados sob usuários diferentes. Defina como `false` para desativar esse comportamento (permissões Unix `0644`). **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## filter\_attributes | Campo | Valor | | ---------------------------------------- | ----------------------------- | | Chave do arquivo de configuração | `filter_attributes` | | Chave de variável de ambiente do sistema | `APPSIGNAL_FILTER_ATTRIBUTES` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `1.6.0` | ### Descrição Lista de atributos de span do OpenTelemetry que serão filtrados pelo AppSignal. Os valores correspondentes são substituídos por `[FILTERED]`. Leia mais sobre a [filtragem de parâmetros](/application/parameter-filtering). **Apenas para o coletor:** esta opção de configuração só terá efeito ao usar [um coletor externo](#option-collector_endpoint). Consulte a opção de configuração [filter\_parameters](#option-filter_parameters) para filtrar dados ao usar o agente. ## filter\_function\_parameters | Campo | Valor | | ---------------------------------------- | -------------------------------------- | | Chave do arquivo de configuração | `filter_function_parameters` | | Chave de variável de ambiente do sistema | `APPSIGNAL_FILTER_FUNCTION_PARAMETERS` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `1.6.0` | ### Descrição Lista de atributos de parâmetros de função que serão filtrados pelo AppSignal. Os valores correspondentes são substituídos por `[FILTERED]`. Leia mais sobre a [filtragem de parâmetros](/application/parameter-filtering). **Apenas para o coletor:** esta opção de configuração só terá efeito ao usar [um coletor externo](#option-collector_endpoint). Consulte a opção de configuração [filter\_parameters](#option-filter_parameters) para filtrar dados ao usar o agente. ## filter\_parameters | Campo | Valor | | ---------------------------------------- | ----------------------------- | | Chave do arquivo de configuração | `filter_parameters` | | Chave de variável de ambiente do sistema | `APPSIGNAL_FILTER_PARAMETERS` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `0.1.0` | ### Descrição Lista de chaves de parâmetros que devem ser ignoradas pela filtragem do AppSignal. Seus valores serão substituídos por `[FILTERED]` quando transmitidos ao AppSignal. Leia mais sobre a [filtragem de parâmetros](/application/parameter-filtering). **Apenas agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem nenhum efeito. Veja as seguintes opções de configuração para filtrar parâmetros ao usar um coletor externo: * [`filter_attributes`](#option-filter_attributes) * [`filter_function_parameters`](#option-filter_function_parameters) * [`filter_request_payload`](#option-filter_request_payload) * [`filter_request_query_parameters`](#option-filter_request_query_parameters) ## filter\_request\_payload | Campo | Valor | | ---------------------------------------- | ---------------------------------- | | Chave do arquivo de configuração | `filter_request_payload` | | Chave de variável de ambiente do sistema | `APPSIGNAL_FILTER_REQUEST_PAYLOAD` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `1.6.0` | ### Descrição Lista de atributos do payload da requisição que serão filtrados pelo AppSignal. Os valores correspondentes são substituídos por `[FILTERED]`. Leia mais sobre a [filtragem de parâmetros](/application/parameter-filtering). **Apenas para o coletor:** esta opção de configuração só terá efeito ao usar [um coletor externo](#option-collector_endpoint). Consulte a opção de configuração [filter\_parameters](#option-filter_parameters) para filtrar dados ao usar o agente. ## filter\_request\_query\_parameters | Campo | Valor | | ---------------------------------------- | ------------------------------------------- | | Chave do arquivo de configuração | `filter_request_query_parameters` | | Chave de variável de ambiente do sistema | `APPSIGNAL_FILTER_REQUEST_QUERY_PARAMETERS` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `1.6.0` | ### Descrição Lista de atributos dos parâmetros de query da requisição que serão filtrados pelo AppSignal. Os valores correspondentes são substituídos por `[FILTERED]`. Leia mais sobre a [filtragem de parâmetros](/application/parameter-filtering). **Apenas para o coletor:** esta opção de configuração só terá efeito ao usar [um coletor externo](#option-collector_endpoint). Consulte a opção de configuração [filter\_parameters](#option-filter_parameters) para filtrar dados ao usar o agente. ## filter\_session\_data | Campo | Valor | | ---------------------------------------- | ------------------------------- | | Chave do arquivo de configuração | `filter_session_data` | | Chave de variável de ambiente do sistema | `APPSIGNAL_FILTER_SESSION_DATA` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `0.1.0` | ### Descrição Lista de chaves de dados de sessão que devem ser ignoradas pela filtragem do AppSignal. Seus valores serão substituídos por `[FILTERED]` quando transmitidos ao AppSignal. Leia mais sobre a [filtragem de dados de sessão](/application/session-data-filtering). ## host\_role | Campo | Valor | | ---------------------------------------- | ----------------------------- | | Chave do arquivo de configuração | `host_role` | | Chave de variável de ambiente do sistema | `APPSIGNAL_HOST_ROLE` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | nil (não definido por padrão) | | Disponível desde a versão | `0.2.2` | ### Descrição Agrupa hosts por função e gera métricas com base nessa função. Uma dessas métricas é a métrica de contador `reporting_hosts`. Uma boa função indica qual é o papel principal do servidor, como "webserver", "processor", "api", "database", "loadbalancer", etc. **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## hostname | Campo | Valor | | ---------------------------------------- | ---------------------- | | Chave do arquivo de configuração | `hostname` | | Chave de variável de ambiente do sistema | `APPSIGNAL_HOSTNAME` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | detectado pelo sistema | | Disponível desde a versão | `0.1.0` | ### Descrição Isso substitui o hostname do servidor. Útil quando você não consegue definir um hostname personalizado ou quando um id pouco descritivo é gerado para você em serviços de hospedagem. ## http\_proxy | Campo | Valor | | ---------------------------------------- | ----------------------------- | | Chave do arquivo de configuração | `http_proxy` | | Chave de variável de ambiente do sistema | `APPSIGNAL_HTTP_PROXY` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | nil (não definido por padrão) | | Disponível desde a versão | `0.1.0` | ### Descrição Se você precisa que o agente se conecte à Internet via proxy, defina a URL completa do proxy nesta chave de configuração. Ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito sobre como a integração se comunica com o coletor externo. Ela ainda será usada na comunicação com os servidores da AppSignal. ## ignore\_actions | Campo | Valor | | ---------------------------------------- | -------------------------- | | Chave do arquivo de configuração | `ignore_actions` | | Chave de variável de ambiente do sistema | `APPSIGNAL_IGNORE_ACTIONS` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `0.1.0` | ### Descrição Com essa opção de configuração, você pode especificar uma lista de ações que serão ignoradas pelo AppSignal. Tudo o que acontecer, incluindo exceções, não será transmitido ao AppSignal. Isso pode ser útil para ignorar endpoints de verificação de saúde ou outras ações que você não deseja monitorar. Leia mais sobre [ignorar ações](/guides/filter-data/ignore-actions). ## ignore\_errors | Campo | Valor | | ---------------------------------------- | ------------------------- | | Chave do arquivo de configuração | `ignore_errors` | | Chave de variável de ambiente do sistema | `APPSIGNAL_IGNORE_ERRORS` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `0.1.0` | ### Descrição Lista de classes de erro que serão ignoradas. Qualquer exceção lançada com essa classe de erro não será transmitida ao AppSignal. Leia mais sobre [ignorar erros](/guides/filter-data/ignore-errors). ## ignore\_namespaces | Campo | Valor | | ---------------------------------------- | ----------------------------- | | Chave do arquivo de configuração | `ignore_namespaces` | | Chave de variável de ambiente do sistema | `APPSIGNAL_IGNORE_NAMESPACES` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `0.1.0` | ### Descrição Lista de namespaces que serão ignorados. Qualquer erro lançado ou requisição lenta que ocorra nesse namespace não será enviado ao AppSignal. Leia mais sobre [namespaces](/application/namespaces). ## log | Campo | Valor | | ---------------------------------------- | --------------- | | Chave do arquivo de configuração | `log` | | Chave de variável de ambiente do sistema | `APPSIGNAL_LOG` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | `file` | | Disponível desde a versão | `0.1.0` | ### Descrição Esta opção configura qual logger a funcionalidade de logging interna do AppSignal utilizará e não afeta o [recurso de logging](/logging). **Observação**: o [agente do AppSignal](/appsignal/how-appsignal-operates), que é utilizado pela integração, sempre escreverá no arquivo "appsignal.log". Selecione qual logger a integração do AppSignal usará. Os valores aceitos são `file` e `stdout`. Veja também a configuração `log_path`. * `file` (padrão) * Escreve todos os logs do AppSignal no sistema de arquivos. * `stdout` (padrão no [Heroku](https://heroku.com)) * Imprime os logs do AppSignal no STDOUT do processo pai, em vez de em um arquivo. Útil com soluções de hospedagem como sistemas de containers e Heroku. Ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito sobre como o coletor emitirá logs. A integração ainda seguirá esta opção de configuração ao emitir logs. ## log\_level | Campo | Valor | | ---------------------------------------- | --------------------- | | Chave do arquivo de configuração | `log_level` | | Chave de variável de ambiente do sistema | `APPSIGNAL_LOG_LEVEL` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | `info` | | Disponível desde a versão | `0.1.0` | ### Descrição Esta opção define o nível de severidade do logger interno do AppSignal e não afeta o [recurso de logging](/logging). Define o nível de severidade do logger interno do AppSignal. Se estiver configurado como "info", ele registrará todas as mensagens de erro, aviso e info, mas não registrará as mensagens de debug. Definir os níveis como "debug" ou "trace" normalmente só é necessário a pedido do suporte. Definir o nível como "debug"/"trace" pode ter um leve impacto no uso do disco e no IO, especialmente em sites de alto tráfego. A sobrecarga de CPU é mínima com a opção debug ativada. Valores aceitos: * error * warning * info * debug * trace Ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito sobre como o coletor emitirá logs. A integração ainda seguirá esta opção de configuração ao emitir logs. ## log\_path | Campo | Valor | | ---------------------------------------- | -------------------- | | Chave do arquivo de configuração | `log_path` | | Chave de variável de ambiente do sistema | `APPSIGNAL_LOG_PATH` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | `/tmp` | | Disponível desde a versão | `0.1.0` | ### Descrição Esta opção configura a localização do arquivo de logging interno do AppSignal e não afeta o [recurso de logging](/logging).
**Observação**: o caminho especificado não pode conter abstrações do sistema de arquivos específicas do sistema operacional, como o símbolo de diretório home `~` para sistemas \*NIX. Isso será visto como um caminho mal formado. Substitua a localização do caminho (diretório) onde o arquivo `appsignal.log` pode ser gravado. Ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito sobre como o coletor emitirá logs. A integração ainda seguirá esta opção de configuração ao emitir logs. ## nginx\_port | Campo | Valor | | ---------------------------------------- | ---------------------- | | Chave do arquivo de configuração | `nginx_port` | | Chave de variável de ambiente do sistema | `APPSIGNAL_NGINX_PORT` | | Obrigatório | não | | Tipo | `Integer` | | Valor padrão | `27649` | | Disponível desde a versão | `1.5.4` | ### Descrição Configura a porta na qual o servidor de métricas do NGINX é exposto. Quando o AppSignal recebe métricas do NGINX, ele escuta em um servidor vinculado a `localhost`, por padrão na porta 27649. Se você estiver executando vários aplicativos instrumentados pelo AppSignal no mesmo servidor com métricas do NGINX habilitadas, use esta opção para configurar cada aplicativo para escutar em uma porta diferente. **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## opentelemetry\_port | Campo | Valor | | ---------------------------------------- | ------------------------------ | | Chave do arquivo de configuração | `opentelemetry_port` | | Chave de variável de ambiente do sistema | `APPSIGNAL_OPENTELEMETRY_PORT` | | Obrigatório | não | | Tipo | `Integer` | | Valor padrão | `8099` | | Disponível desde a versão | `0.2.2` | ### Descrição Defina esta opção para configurar a porta do servidor HTTP do OpenTelemetry do processo do agente do AppSignal. Configure esta porta se outro processo já estiver em execução na máquina e também estiver usando esta porta, para evitar conflitos. **Apenas agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem nenhum efeito. A porta a ser usada para enviar dados do OpenTelemetry ao coletor externo pode ser especificada como parte da [opção de configuração `collector_endpoint`](#option-collector_endpoint). ## request\_headers | Campo | Valor | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | Chave do arquivo de configuração | `request_headers` | | Chave de variável de ambiente do sistema | `APPSIGNAL_REQUEST_HEADERS` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "range"]` | | Disponível desde a versão | `0.1.0` | ### Descrição A opção de configuração `request_headers` contém uma lista de cabeçalhos HTTP da requisição que são lidos e armazenados pelo pacote AppSignal para Python. Essa opção de configuração `request_headers` é uma *allowlist*, o que significa que ela só considerará os cabeçalhos especificados nesta opção de configuração. Se essa opção não estiver definida, será usado o padrão do AppSignal. A lista a seguir é o padrão do pacote AppSignal. ```python Python theme={null} # __appsignal__.py appsignal = Appsignal( # ...Outras opções de configuração request_headers=[ "accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "range" ] ) ``` Para personalizar esta lista, adicione a opção de configuração com *todos os cabeçalhos* que você deseja reportar. Todos os nomes de cabeçalhos devem ser escritos em letras minúsculas. Se o nome do cabeçalho for `X-Custom-Header`, adicione-o a esta lista como `x-custom-header`. Para configurar o AppSignal para não armazenar nenhum cabeçalho HTTP de requisição nos traces do AppSignal, configure a opção com uma lista vazia. ```python Python theme={null} # __appsignal__.py appsignal = Appsignal( # ...Outras opções de configuração request_headers=[] ) ``` ## response\_headers | Campo | Valor | | ---------------------------------------- | ---------------------------- | | Chave do arquivo de configuração | `response_headers` | | Chave de variável de ambiente do sistema | `APPSIGNAL_RESPONSE_HEADERS` | | Obrigatório | não | | Tipo | `list(String)` | | Valor padrão | `[]` | | Disponível desde a versão | `1.6.0` | ### Descrição A opção de configuração `response_headers` contém uma lista de cabeçalhos HTTP de resposta que são lidos e armazenados pelo pacote AppSignal para Python. Essa opção de configuração `response_headers` é uma *allowlist*, o que significa que ela só considerará os cabeçalhos especificados nesta opção de configuração. Se essa opção não estiver definida, ela não reportará nenhum cabeçalho de resposta. Para personalizar esta lista, adicione a opção de configuração com *todos os cabeçalhos* que você deseja reportar. Todos os nomes de cabeçalhos devem ser escritos em letras minúsculas. Se o nome do cabeçalho for `X-Custom-Header`, adicione-o a esta lista como `x-custom-header`. **Apenas para o coletor:** esta opção de configuração só terá efeito ao usar [um coletor externo](#option-collector_endpoint). ## revision | Campo | Valor | | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | Chave do arquivo de configuração | `revision` | | Chave de variável de ambiente do sistema | `APP_REVISION` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | nil (não definido por padrão) | | Disponível desde a versão | `0.1.0` | | | | ### Descrição Defina a revisão do aplicativo para reportar a versão atualmente em execução do seu aplicativo. O AppSignal criará um marcador de deploy quando este valor mudar e marcará todos os dados recebidos com a revisão atual. Quando seu aplicativo é implantado usando o Kamal, ou quando é implantado no Render, ou quando é implantado no Heroku e o recurso [Heroku Labs: Dyno Metadata](https://devcenter.heroku.com/articles/dyno-metadata) está habilitado, a integração do AppSignal detectará automaticamente o commit Git da implantação atual e o usará como revisão. Você pode sobrescrever as revisões detectadas automaticamente no Heroku, Render ou Kamal definindo manualmente a opção de configuração `revision` com um valor personalizado. Leia mais sobre marcadores de deploy no tópico de [marcadores de deploy](/application/markers/deploy-markers). Ao usar [um coletor externo](#option-collector_endpoint), a revisão não é detectada automaticamente. Defina esta opção manualmente para reportar a versão atualmente em execução do seu aplicativo. ## running\_in\_container | Campo | Valor | | ---------------------------------------- | -------------------------------- | | Chave do arquivo de configuração | `running_in_container` | | Chave de variável de ambiente do sistema | `APPSIGNAL_RUNNING_IN_CONTAINER` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | detectado pelo agente | | Disponível desde a versão | `0.1.0` | ### Descrição O AppSignal espera estar sendo executado na mesma máquina entre deploys diferentes. Defina esta chave como `true` se o aplicativo estiver sendo executado em um container, como com o Docker. Versões mais recentes da integração do AppSignal detectam automaticamente seu ambiente de container, portanto, nenhuma configuração manual é necessária. Se estiver tendo problemas com a detecção automática, [entre em contato com o suporte](mailto:support@appsignal.com). Esta opção é definida como `true` automaticamente no [Heroku](http://heroku.com/). **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## send\_environment\_metadata | Campo | Valor | | ---------------------------------------- | ------------------------------------- | | Chave do arquivo de configuração | `send_environment_metadata` | | Chave de variável de ambiente do sistema | `APPSIGNAL_SEND_ENVIRONMENT_METADATA` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `true` | | Disponível desde a versão | `0.1.0` | ### Descrição Envia metadados do ambiente sobre o aplicativo. Para mais informações, leia sobre [metadados de ambiente](/application/environment-metadata). **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## send\_function\_parameters | Campo | Valor | | ---------------------------------------- | ------------------------------------ | | Chave do arquivo de configuração | `send_function_parameters` | | Chave de variável de ambiente do sistema | `APPSIGNAL_SEND_FUNCTION_PARAMETERS` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `true` | | Disponível desde a versão | `1.6.0` | ### Descrição Se deve enviar parâmetros de função ao AppSignal. **Apenas para o coletor:** esta opção de configuração só terá efeito ao usar [um coletor externo](#option-collector_endpoint). Consulte a opção de configuração [send\_params](#option-send_params) para enviar dados quando não estiver usando o agente. ## send\_params | Campo | Valor | | ---------------------------------------- | -------------------------- | | Chave do arquivo de configuração | `send_params` | | Chave de variável de ambiente do sistema | `APPSIGNAL_SEND_PARAMS` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `true` | | Disponível desde a versão | `0.1.0` | ### Descrição Se deve pular o envio de parâmetros da requisição ao AppSignal. Para mais informações, leia sobre [send\_params](/application/parameter-filtering) na filtragem de parâmetros de requisição. **Apenas agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem nenhum efeito. Veja as seguintes opções de configuração para enviar parâmetros ao usar um coletor externo: * [`send_function_parameters`](#option-send_function_parameters) * [`send_request_payload`](#option-send_request_payload) * [`send_request_query_parameters`](#option-send_request_query_parameters) ## send\_request\_payload | Campo | Valor | | ---------------------------------------- | -------------------------------- | | Chave do arquivo de configuração | `send_request_payload` | | Chave de variável de ambiente do sistema | `APPSIGNAL_SEND_REQUEST_PAYLOAD` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `true` | | Disponível desde a versão | `1.6.0` | ### Descrição Se deve enviar o payload da requisição ao AppSignal. **Apenas para o coletor:** esta opção de configuração só terá efeito ao usar [um coletor externo](#option-collector_endpoint). Consulte a opção de configuração [send\_params](#option-send_params) para enviar dados quando não estiver usando o agente. ## send\_request\_query\_parameters | Campo | Valor | | ---------------------------------------- | ----------------------------------------- | | Chave do arquivo de configuração | `send_request_query_parameters` | | Chave de variável de ambiente do sistema | `APPSIGNAL_SEND_REQUEST_QUERY_PARAMETERS` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `true` | | Disponível desde a versão | `1.6.0` | ### Descrição Se deve enviar parâmetros de query da requisição ao AppSignal. **Apenas para o coletor:** esta opção de configuração só terá efeito ao usar [um coletor externo](#option-collector_endpoint). Consulte a opção de configuração [send\_params](#option-send_params) para enviar dados quando não estiver usando o agente. ## send\_session\_data | Campo | Valor | | ---------------------------------------- | ----------------------------- | | Chave do arquivo de configuração | `send_session_data` | | Chave de variável de ambiente do sistema | `APPSIGNAL_SEND_SESSION_DATA` | | Obrigatório | não | | Tipo | Boolean (`true` / `false`) | | Valor padrão | `true` | | Disponível desde a versão | `0.1.0` | ### Descrição Defina esta opção como `false` para não enviar nenhum dado de sessão com traces de exceções e amostras de problemas de desempenho. Para mais informações, leia sobre [filtragem de dados de sessão da requisição](/application/session-data-filtering). ## service\_name | Campo | Valor | | ---------------------------------------- | ------------------------ | | Chave do arquivo de configuração | `service_name` | | Chave de variável de ambiente do sistema | `APPSIGNAL_SERVICE_NAME` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | \`\` | | Disponível desde a versão | `1.6.0` | ### Descrição O nome do serviço ajuda o AppSignal a reconhecer diferentes serviços para os traces e agrupa os traces automaticamente em um namespace com base no nome do serviço. Escolha um nome que se adeque ao seu aplicativo, como "Web server", "Background worker", "Email service", "Authentication service", etc. **Apenas para o coletor:** esta opção de configuração só terá efeito ao usar [um coletor externo](#option-collector_endpoint). ## statsd\_port | Campo | Valor | | ---------------------------------------- | ----------------------- | | Chave do arquivo de configuração | `statsd_port` | | Chave de variável de ambiente do sistema | `APPSIGNAL_STATSD_PORT` | | Obrigatório | não | | Tipo | `Integer` | | Valor padrão | `8125` | | Disponível desde a versão | `0.2.2` | ### Descrição Defina esta opção para configurar a porta do servidor HTTP do StatsD do processo do agente do AppSignal. Configure esta porta se outro processo já estiver em execução na máquina e também estiver usando esta porta, para evitar conflitos. **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito. ## working\_directory\_path | Campo | Valor | | ---------------------------------------- | ---------------------------------- | | Chave do arquivo de configuração | `working_directory_path` | | Chave de variável de ambiente do sistema | `APPSIGNAL_WORKING_DIRECTORY_PATH` | | Obrigatório | não | | Tipo | `String` | | Valor padrão | detectado pelo agente | | Disponível desde a versão | `0.1.0` | ### Descrição Substitui a localização onde o AppSignal para Python pode armazenar arquivos temporários. Use esta opção se a localização padrão não for adequada. Consulte nossa página [como o AppSignal opera](/appsignal/how-appsignal-operates) para mais informações sobre o propósito desse diretório de trabalho. Se você estiver executando vários aplicativos usando o AppSignal no mesmo servidor, use esta opção de configuração para selecionar diretórios de trabalho diferentes para cada instância do AppSignal; caso contrário, as duas instâncias podem entrar em conflito. Para mais informações sobre esse cenário, consulte nossa documentação de [executando vários aplicativos em um único host](/guides/application/multiple-applications-on-one-host). ```python Python theme={null} # __appsignal__.py appsignal = Appsignal( # Outras configurações working_directory_path="/tmp/project_1" ) ``` **Observação**: o caminho especificado não pode conter abstrações do sistema de arquivos específicas do sistema operacional, como o símbolo de diretório home `~` para sistemas \*NIX. Isso será visto como um caminho mal formado. **Apenas para o agente:** ao usar [um coletor externo](#option-collector_endpoint), esta opção de configuração não tem efeito.