Configuração ODL

Cada produto Oracle Enterprise Performance Management System que usa o formato de log ODL tem, pelo menos, um arquivo de configuração de log, o logging.xml. Os componentes do EPM System têm nomes descritivos no formato loggingCOMPONENT_NAME.xml.

Os arquivos de configuração do log incluem duas seções: log_handlers e loggers. A seção log_handlers define os agentes de log e seus parâmetros, enquanto a seção loggers identifica os detalhes, incluindo o nível de log e o log_handler a ser usado.

Consulte Tabela 3-9 para obter uma lista de propriedades log_handler que você pode especificar.

Níveis de Log ODL

Tabela 3-7 Níveis de Log ODL

Nível Descrição
INCIDENT_ERROR:1 Mensagens relacionadas a um problema sério causado por motivos desconhecidos. Os usuários devem recorrer ao suporte da Oracle a fim de resolver o problema.
ERROR:1 Mensagens relacionadas a um problema sério que requer atenção imediata do Administrador do Sistema, mas que não é causado por um defeito em um componente do EPM System
WARNING:1 Mensagens relacionadas a um problema potencial que um Administrador de Sistema deve revisar
NOTIFICATION:1 Mensagens relacionadas a um evento importante do ciclo de vida, como a ativação ou desativação de um subcomponente ou recurso principal
NOTIFICATION:16 Mensagens relacionadas a eventos normais nos componentes do EPM System
TRACE:1 Rastreie ou depure mensagens de eventos que são significativas para os usuários finais dos componentes do EPM System
TRACE:16 Mensagens de depuração ou rastreamento detalhadas que o Oracle Support pode usar para diagnosticar problemas com os componentes do EPM System
TRACE:32 Mensagens de depuração ou rastreamento muito detalhadas, geralmente destinadas a um Desenvolvedor Oracle para localizar a origem do erro emanado

Arquivo de Configuração ODL: Implantações do Servidor Gerenciado Único

A implantação dos componentes do EPM System em um servidor gerenciado único gera um arquivo de configuração de log unificado, logging.xml, para todos os aplicativos Web Java implantados. Em um servidor do Windows, esse arquivo geralmente está localizado em MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/EPMServer0.

Arquivos de Configuração ODL: Implantações Padrão

A implantação padrão do EPM System gera um arquivo de configuração de log, logging.xml, para cada aplicativo Web Java implantado. Em um servidor do Windows, esses arquivos geralmente estão localizados deste modo:

Tabela 3-8 Local dos Arquivos de Configuração ODL em Implantações Padrão

Componente Local de logging.xml
Servidor de Administração (Console de Administração do Oracle WebLogic Server, Oracle Web Services Manager, Enterprise Manager) MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/AdminServer/logging.xml
Oracle Hyperion Provider Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/AnalyticProviderServices0/logging.xml
Oracle Hyperion Calculation Manager MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/CalcMgr0/logging.xml
Oracle Essbase Administration Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/EssbaseAdminServices0/logging.xml
Oracle Hyperion Foundation Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/FoundationServices0/logging.xml
Oracle Hyperion Financial Management Web MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/HFMWeb0/logging.xml
Oracle Hyperion Planning MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/Planning0/logging.xml

Modificação de Arquivos de Configuração ODL

Você modifica as propriedades dos agentes de log definidas em logging.xml para determinar os níveis de mensagem que são registrados. Por padrão, o nível de log apropriado para operação normal dos componentes do EPM System é definido no logging.xml. Os parâmetros adicionais do identificador de log podem ser definidos para alterar o comportamento do log. Por exemplo, é possível especificar a frequência de rotação do arquivo de log incluindo o parâmetro rotationFrequency no identificador de log. Consulte Tabela 3-9 para obter uma lista abrangente de parâmetros.

Tabela 3-9 Propriedades de Log ODL Configuráveis

Propriedade do Log Descrição

path

Caminho do log

format

Formato a ser usado

O valor recomendado é ODL-Text.

maxFileSize

Tamanho máximo em bytes para cada arquivo de log

Quando o arquivo de log principal atinge o tamanho determinado, uma rotação de log é acionada, e o arquivo de log principal é arquivado e outro é criado.

maxLogSize

Tamanho máximo em bytes para o log inteiro

Os arquivos antigos são excluídos para que o tamanho total do log se mantenha abaixo do limite determinado.

rotationFrequency

Frequência, em minutos, para rotação dos logs

O valor deve ser um número (de minutos) ou a palavra hourly, daily ou weekly. (Essa configuração não diferencia maiúsculas de minúsculas.)

baseRotationTime

Hora base para rotação de log baseada no tempo; por exemplo, o ponto de partida para a configuração rotationFrequency

Padrão: 1º de janeiro de 1970, UTC

Use um destes formatos:

  • HH:mm

  • aaaa-MM-dd

  • aaaa-MM-ddT-HH:mm

  • aaaa-MM-dd-HH:mm:ss.sTZ, onde TZ é o indicador de fuso horário e pode ser Z para UTC ou um deslocamento do Horário do Meridiano de Greenwich no formato plus_or_minusHH:mmm

Nota:

Se o formato de hora não especificar um fuso horário, o fuso horário local será usado.

retentionPeriod

Por quanto tempo os arquivos de log são mantidos

Os arquivos que ultrapassam o período determinado são excluídos. Os arquivos são excluídos somente quando há uma rotação de log; nenhum encadeamento em segundo plano exclui arquivos de log. Consequentemente, os arquivos talvez não possam ser excluídos por algum tempo depois que o período de retenção expira. O valor deve ser um número (minutos), ou dia, semana, mês (30 dias), ou ano (valores não diferenciam maiúsculas de minúsculas).

encoding

O tipo de codificação de caracteres a ser usado

Arquivos XML devem ser codificados em UTF-8 para tratar de caracteres estendidos. O padrão é <?xml version="1.0" encoding="UTF-8" ?>.

supplementalAttributes

Uma lista separada por vírgulas de nomes de atributo complementares, que podem ser adicionados a cada mensagem de log

O valor do atributo deve ser definido na classe ExecutionContext.

useSourceClassAndMethod

Se o nome do método e a classe da origem Java devem ser adicionados a cada mensagem de log

O valor é um nome de Nível. Mensagens de um determinado nível ou inferior incluem a classe de origem e o nome do método. As constantes true e false também são aceitas como aliases para OFF e ALL. O valor padrão é TRACE:1 (Fine).

useDefaultAttributes

Se os valores de atributo padrão devem ser adicionados a cada mensagem de log

Os atributos padrão que podem ser atribuídos são HOST_ID, HOST_NWADDR e USER_ID. O valor deve ser true ou false. O valor padrão é true para o formato ODL-XML e false para o formato ODL-Texto.

includeMessageArguments

Se os argumentos da mensagem são incluídos com mensagens de log formatadas que também têm um ID de mensagem

Valores possíveis: true (padrão) ou false.

useThreadName

O indicador useThreadName, que sinaliza controles se o identificador tentar registrar o nome real do encadeamento em vez do threadID fornecido por java.util.logging.LogRecord.

Se o indicador for true, o identificador tentará registrar o nome do encadeamento real. Em alguns casos, o identificador talvez não possa determinar o nome real do encadeamento, caso em que registrará o threadID. O valor padrão é true.

useRealThreadId

O indicador useRealThreadId, que sinaliza controles se o identificador tentar registrar o ID real do encadeamento em vez do threadID fornecido por java.util.logging.LogRecord.

Se o indicador for true, o identificador tentará registrar o ID do encadeamento real. Em alguns casos, o identificador talvez não possa determinar o nome real do encadeamento, caso em que registrará o threadID. O valor padrão é false. O registro em log do ID de Encadeamento real é mutuamente exclusivo com a propriedade useThreadName. Se useThreadName for true, o valor da propriedade useRealThreadId será ignorado.

locale

Substituição da Localidade Padrão para mensagens de localização

O valor padrão é a Localidade padrão, que é definida no EPM System Configurator.

keepOpen

Se o arquivo de log principal é mantido aberto o tempo todo ou é aberto e fechado a cada operação do log.

Configurações possíveis: true e false. A configuração padrão é true, que mantém o arquivo de log principal aberto o tempo todo.

Na maioria dos casos, você deve usar o valor padrão.

autoFlushLevel

A configuração de nível para liberação automática

ODLHandler permite que registros de log sejam armazenados no buffer, mas ele automaticamente libera o buffer quando obtém um registro de log com nível igual ou superior ao nível especificado de autoFlush. O valor padrão é NOTIFICATION:1.

addJvmNumber

O número da JVM adicionado ao nome do arquivo de log

O número da JVM é definido pela propriedade do sistema oracle.process.index. Se a propriedade do sistema não for definida, essa opção será ignorada.

applicationContextProvider

O nome de uma classe que implementa a interface ApplicationContext

A classe deve ter um construtor padrão. O valor especial disabled pode ser usado para desativar o log do nome do aplicativo. O provedor de contexto do aplicativo padrão é específico da plataforma; na maioria dos casos, você não precisa definir essa propriedade.

userContextProvider

O nome de uma classe que implementa a interface UserContext

A classe deve ter um construtor padrão. O valor especial disabled pode ser usado para desativar o log do nome do usuário. O provedor de contexto do usuário padrão é específico da plataforma; na maioria dos casos, você não precisa definir essa propriedade.

Você modifica as propriedades de agentes de log para depurar um componente ou gerar as informações que o Oracle Support solicita para identificar problemas com um componente do EPM System.

Por exemplo, para capturar as mensagens de depuração do Oracle Hyperion Shared Services, altere o nível de log em cada definição do agente de log do Shared Services para TRACE:32.

Nota:

Depois que a depuração estiver concluída, restaure o logging.xml original de uma cópia de backup para garantir configurações adequadas de log.

Para modificar o arquivo de configuração de log:

  1. Crie uma cópia de backup do arquivo de configuração de log do componente do EPM System cujo comportamento de log deve ser alterado. Consulte Matriz de Log de Produtos EPM System.

  2. Usando um editor de texto, abra logging.xml.

  3. Localize as definições do agente de log. Por exemplo, para alterar o nível de log do Shared Services, altere as seguintes definições do agente de log:

    <logger name="oracle.EPMCAS" level="NOTIFICATION:1" useParentHandlers="false">
         <handler name="epmcas-handler" />
    </logger>
    <logger name="oracle.EPMCES" level="NOTIFICATION:1" useParentHandlers="false">
         <handler name="epmces-handler" />
    </logger>
    <logger name="oracle.EPMCMS" level="NOTIFICATION:1" useParentHandlers="false">
         <handler name="epmcms-handler" />
    </logger>
    <logger level="NOTIFICATION:1" name="oracle.EPMCSS">
         <handler name="epmcss-handler" />
    </logger>
  4. Modifique a propriedade level conforme a necessidade para alterar o nível de log da mensagem. Por exemplo, defina a propriedade level de cada agente de log para TRACE:32 a fim de registrar mensagens de depuração detalhadas.

    Consulte Níveis de Log ODL.

  5. Salve e feche logging.xml.

  6. Reinicie o componente do EPM System para ativar as alterações.