Download php json logger - download do código-fonte php json logger

php-json-logger

LoggingLibrary para PHP. Saída por formato JSON

Esta biblioteca destina-se principalmente ao uso em aplicações web.

Começando

Instale o pacote compositor

 composer require nekonomokochan/php-json-logger

Como usar

Uso básico

 <?php
use Nekonomokochan  PhpJsonLogger  LoggerBuilder ;

$ context = [
    ' title ' => ' Test ' ,
    ' price ' => 4000 ,
    ' list '  => [ 1 , 2 , 3 ],
    ' user '  => [
        ' id '   => 100 ,
        ' name ' => ' keitakn ' ,
    ],
];

$ loggerBuilder = new LoggerBuilder ();
$ logger = $ loggerBuilder -> build ();
$ logger -> info ( ' ? ' , $ context );

A saída é a seguinte.

{
    "log_level" : " INFO " ,
    "message" : " ? " ,
    "channel" : " PhpJsonLogger " ,
    "trace_id" : " 35b627ce-55e0-4729-9da0-fbda2a7d817d " ,
    "file" : " / home / vagrant / php-json-logger / tests / LoggerTest.php " ,
    "line" : 42 ,
    "context" : {
        "title" : " Test " ,
        "price" : 4000 ,
        "list" : [
            1 ,
            2 ,
            3
        ],
        "user" : {
            "id" : 100 ,
            "name" : " keitakn "
        }
    },
    "remote_ip_address" : " 127.0.0.1 " ,
    "server_ip_address" : " 127.0.0.1 " ,
    "user_agent" : " unknown " ,
    "datetime" : " 2018-06-04 17:21:03.631409 " ,
    "timezone" : " Asia / Tokyo " ,
    "process_time" : 631.50811195373535
}

A unidade de process_time é ms (milissegundo).

Como alterar o caminho do arquivo de saída

O caminho do arquivo de saída padrão é /tmp/php-json-logger-yyyy-mm-dd.log .

Se você deseja alterar o caminho do arquivo de saída, defina o caminho do arquivo de saída para a classe do construtor.

 <?php
use Nekonomokochan  PhpJsonLogger  LoggerBuilder ;

$ fileName = ' /tmp/test-php-json-logger.log ' ;

$ context = [
    ' cat '    => ' ? ' ,
    ' dog '    => ' ? ' ,
    ' rabbit ' => ' ? ' ,
];

$ loggerBuilder = new LoggerBuilder ();
$ loggerBuilder -> setFileName ( $ fileName );
$ logger = $ loggerBuilder -> build ();
$ logger -> info ( ' testSetLogFileName ' , $ context );

O caminho do arquivo de saída é /tmp/test-php-json-logger-yyyy-mm-dd.log .

A saída é a seguinte.

{
    "log_level" : " INFO " ,
    "message" : " testSetLogFileName " ,
    "channel" : " PhpJsonLogger " ,
    "trace_id" : " 20f39cdb-dbd8-470c-babd-093a2974d169 " ,
    "file" : " / home / vagrant / php-json-logger / tests / LoggerTest.php " ,
    "line" : 263 ,
    "context" : {
        "cat" : " ? " ,
        "dog" : " ? " ,
        "rabbit" : " ? "
    },
    "remote_ip_address" : " 127.0.0.1 " ,
    "server_ip_address" : " 127.0.0.1 " ,
    "user_agent" : " unknown " ,
    "datetime" : " 2018-06-05 11:28:03.214995 " ,
    "timezone" : " Asia / Tokyo " ,
    "process_time" : 215.09790420532227
}

Como definir `trace_id`

Qualquer valor pode ser definido para trace_id .

Isso o ajudará na procura dos registros desejados.

 <?php
use Nekonomokochan  PhpJsonLogger  LoggerBuilder ;

$ context = [
    ' name ' => ' keitakn ' ,
];

$ loggerBuilder = new LoggerBuilder ();
$ loggerBuilder -> setTraceId ( ' MyTraceID ' );
$ logger = $ loggerBuilder -> build ();
$ logger -> info ( ' testSetTraceIdIsOutput ' , $ context );

A saída é a seguinte.

{
    "log_level" : " INFO " ,
    "message" : " testSetTraceIdIsOutput " ,
    "channel" : " PhpJsonLogger " ,
    "trace_id" : " MyTraceID " ,
    "file" : " / home / vagrant / php-json-logger / tests / LoggerTest.php " ,
    "line" : 214 ,
    "context" : {
        "name" : " keitakn "
    },
    "remote_ip_address" : " 127.0.0.1 " ,
    "server_ip_address" : " 127.0.0.1 " ,
    "user_agent" : " unknown " ,
    "datetime" : " 2018-06-05 11:36:02.394269 " ,
    "timezone" : " Asia / Tokyo " ,
    "process_time" : 394.35911178588867
}

Como alterar o nível de log

Por favor use NekonomokochanPhpJsonLoggerLoggerBuilder::setLogLevel() .

Por exemplo, o código a seguir não gera logs.

Porque o nível está definido como CRITICAL .

 <?php
use Nekonomokochan  PhpJsonLogger  LoggerBuilder ;

$ context = [
    ' cat '    => ' ? ' ,
    ' dog '    => ' ? ' ,
    ' rabbit ' => ' ? ' ,
];

$ loggerBuilder = new LoggerBuilder ();
$ loggerBuilder -> setLogLevel (LoggerBuilder:: CRITICAL );
$ logger = $ loggerBuilder -> build ();
$ logger -> info ( ' testSetLogLevel ' , $ context );

Você pode definir os seguintes valores para logLevel .

Eles são iguais ao logLevel definido no Monolog.

DEBUGAR = 100
INFORMAÇÕES = 200
AVISO = 250
AVISO = 300
ERRO = 400
CRÍTICO = 500
ALERTA = 550
EMERGÊNCIA = 600

Como mudar de canal

O canal padrão é PhpJsonLogger .

Se quiser mudar de canal, você pode alterá-lo com o código a seguir.

 $ loggerBuilder = new LoggerBuilder ();
$ loggerBuilder -> setChannel ( ' My Favorite Animals ' );

Por exemplo, a saída é a seguinte.

{
    "log_level" : " INFO " ,
    "message" : " testCanSetChannel " ,
    "channel" : " My Favorite Animals " ,
    "trace_id" : " 4b8aa070-a533-4376-9bf5-270c8fcc6d87 " ,
    "file" : " / home / vagrant / php-json-logger / tests / Logger / LoggerTest.php " ,
    "line" : 347 ,
    "context" : {
        "animals" : " ????? "
    },
    "remote_ip_address" : " 127.0.0.1 " ,
    "server_ip_address" : " 127.0.0.1 " ,
    "user_agent" : " unknown " ,
    "datetime" : " 2018-06-07 17:56:48.538117 " ,
    "timezone" : " Asia / Tokyo " ,
    "process_time" : 538.48695755004883
}

Como alterar a data de rotação do log

Esta é a configuração padrão para salvar logs por 7 dias.

Se quiser alterar a data de rotação do log, você pode alterá-la com o código a seguir.

O código a seguir define o período de retenção de log como 2 dias.

 $ loggerBuilder = new LoggerBuilder ();
$ loggerBuilder -> setMaxFiles ( 2 );

Estenda e use `NekonomokochanPhpJsonLoggerJsonFormatter`

Você pode criar seu próprio MonologLogger usando apenas NekonomokochanPhpJsonLoggerJsonFormatter .

Este método é útil quando você precisa MonologLogger em uma estrutura de aplicação web (por exemplo, Laravel).

A seguir está um código de exemplo.

 <?php
use Monolog  Logger ;
use Monolog  Handler  RotatingFileHandler ;
use Monolog  Processor  IntrospectionProcessor ;
use Nekonomokochan  PhpJsonLogger  JsonFormatter ;

$ logFileName = ' /tmp/extended-monolog-test.log ' ;

// create extendedMonolog Instance
$ formatter = new JsonFormatter ();

$ rotating = new RotatingFileHandler (
    $ logFileName ,
    7 ,
    Logger:: INFO
);
$ rotating -> setFormatter ( $ formatter );

$ introspection = new IntrospectionProcessor (
    Logger:: INFO ,
    [ ' Nekonomokochan \ PhpJsonLogger \' ],
    0
);

$ extraRecords = function ( $ record ) {
    $ record [ ' extra ' ][ ' trace_id ' ] = ' ExtendedMonologTestTraceId ' ;
    $ record [ ' extra ' ][ ' created_time ' ] = microtime ( true );

    return $ record ;
};

$ extendedMonolog = new Logger (
    ' ExtendedMonolog ' ,
    [ $ rotating ],
    [ $ introspection , $ extraRecords ]
);

// output info log
$ context = [
    ' cat '    => ' ? ' ,
    ' dog '    => ' ? ' ,
    ' rabbit ' => ' ? ' ,
];

$ extendedMonolog -> info ( ' outputInfoLogTest ' , $ context );

A saída é estendida para extended-monolog-test-yyyy-mm-dd.log da seguinte forma

{
    "log_level" : " INFO " ,
    "message" : " outputInfoLogTest " ,
    "channel" : " ExtendedMonolog " ,
    "trace_id" : " ExtendedMonologTestTraceId " ,
    "file" : " / home / vagrant / php-json-logger / tests / ExtendedMonologTest.php " ,
    "line" : 85 ,
    "context" : {
        "cat" : " ? " ,
        "dog" : " ? " ,
        "rabbit" : " ? "
    },
    "remote_ip_address" : " 127.0.0.1 " ,
    "server_ip_address" : " 127.0.0.1 " ,
    "user_agent" : " unknown " ,
    "datetime" : " 2018-06-06 17:14:26.042013 " ,
    "timezone" : " Asia / Tokyo " ,
    "process_time" : 0.1678466796875
}

O código a seguir é necessário para gerar trace_id e process_time .

 <?php
$ extraRecords = function ( $ record ) {
    $ record [ ' extra ' ][ ' trace_id ' ] = ' ExtendedMonologTestTraceId ' ;
    $ record [ ' extra ' ][ ' created_time ' ] = microtime ( true );

    return $ record ;
};

O código abaixo é o código necessário para exibir normalmente o rastreamento de pilha com JSON.

 <?php
$ introspection = new IntrospectionProcessor (
    Logger:: INFO ,
    [ ' Nekonomokochan \ PhpJsonLogger \' ],
    0
);

Para enviar o rastreamento de pilha para o log, execute o código a seguir.

 <?php
$ exception = new  Exception ( ' ExtendedMonologTest.outputErrorLog ' , 500 );
$ context = [
    ' cat '    => ' ?(=^・^=)? ' ,
    ' dog '    => ' ?Uo･ｪ･oU? ' ,
    ' rabbit ' => ' ??? ' ,
];

$ extendedMonolog -> error (
    get_class ( $ exception ),
    $ this -> formatPhpJsonLoggerErrorsContext ( $ exception , $ context )
);

Por favor, preste atenção na parte $this->formatPhpJsonLoggerErrorsContext($exception, $context) .

Este é o processamento necessário para formatar o log de erros em JSON e exibi-lo.

Este é o método implementado em NekonomokochanPhpJsonLoggerErrorsContextFormat .

A saída é estendida para extended-monolog-test-yyyy-mm-dd.log da seguinte forma.

Se você quiser saber o uso mais detalhado, consulte php-json-logger/tests/ExtendedMonologTest.php .

{
    "log_level" : " ERROR " ,
    "message" : " Exception " ,
    "channel" : " PhpJsonLogger " ,
    "trace_id" : " ExtendedMonologTestTraceId " ,
    "file" : " / home / vagrant / php-json-logger / tests / ExtendedMonologTest.php " ,
    "line" : 126 ,
    "context" : {
        "cat" : " ?(=^・^=)? " ,
        "dog" : " ?Uo･ｪ･oU? " ,
        "rabbit" : " ??? "
    },
    "remote_ip_address" : " 127.0.0.1 " ,
    "server_ip_address" : " 127.0.0.1 " ,
    "user_agent" : " unknown " ,
    "datetime" : " 2018-06-06 17:37:57.440757 " ,
    "timezone" : " Asia / Tokyo " ,
    "process_time" : 0.16093254089355469 ,
    "errors" : {
        "message" : " ExtendedMonologTest.outputErrorLog " ,
        "code" : 500 ,
        "file" : " / home / vagrant / php-json-logger / tests / ExtendedMonologTest.php " ,
        "line" : 117 ,
        "trace" : [
            " #0 / home / vagrant / php-json-logger / vendor / phpunit / phpunit / src / Framework / TestCase.php(1145): Nekonomokochan \ Tests \ ExtendedMonologTest->outputErrorLog() " ,
            " #1 / home / vagrant / php-json-logger / vendor / phpunit / phpunit / src / Framework / TestCase.php(840): PHPUnit \ Framework \ TestCase->runTest() " ,
            " #2 / home / vagrant / php-json-logger / vendor / phpunit / phpunit / src / Framework / TestResult.php(645): PHPUnit \ Framework \ TestCase->runBare() " ,
            " #3 / home / vagrant / php-json-logger / vendor / phpunit / phpunit / src / Framework / TestCase.php(798): PHPUnit \ Framework \ TestResult->run() " ,
            " #4 / home / vagrant / php-json-logger / vendor / phpunit / phpunit / src / Framework / TestSuite.php(776): PHPUnit \ Framework \ TestCase->run() " ,
            " #5 / home / vagrant / php-json-logger / vendor / phpunit / phpunit / src / TextUI / TestRunner.php(529): PHPUnit \ Framework \ TestSuite->run() " ,
            " #6 / home / vagrant / php-json-logger / vendor / phpunit / phpunit / src / TextUI / Command.php(198): PHPUnit \ TextUI \ TestRunner->doRun() " ,
            " #7 / home / vagrant / php-json-logger / vendor / phpunit / phpunit / src / TextUI / Command.php(151): PHPUnit \ TextUI \ Command->run() " ,
            " #8 / home / vagrant / php-json-logger / vendor / phpunit / phpunit / phpunit(53): PHPUnit \ TextUI \ Command::main() "
        ]
    }
}

Notificação para Slack

Para enviar o log para o Slack, execute o seguinte código.

Este código será enviado para o slack se o nível de log for CRITICAL ou superior.

 <?php
use Nekonomokochan  PhpJsonLogger  LoggerBuilder ;
use Nekonomokochan  PhpJsonLogger  SlackHandlerBuilder ;

$ exception = new  Exception ( ' TestException ' , 500 );
$ context = [
    ' name '  => ' keitakn ' ,
    ' email ' => ' [email protected] ' ,
];

$ slackToken = ' YOUR_SLACK_TOKEN ' ;
$ slackChannel = ' YOUR_SLACK_CHANNEL ' ;

$ slackHandlerBuilder = new SlackHandlerBuilder ( $ slackToken , $ slackChannel );
$ slackHandlerBuilder -> setLevel (LoggerBuilder:: CRITICAL );

$ loggerBuilder = new LoggerBuilder ();
$ loggerBuilder -> setFileName ( $ this -> outputFileBaseName );
$ loggerBuilder -> setSlackHandler ( $ slackHandlerBuilder -> build ());
$ logger = $ loggerBuilder -> build ();
$ logger -> critical ( $ exception , $ context );

Usar no Docker

Use LoggerBuilder.setUseInDocker para usá-lo no Docker.

Quando setUseInDocker é definido como true, nenhuma saída de arquivo é feita e o log é gerado como stdout .

 <?php
use Nekonomokochan  PhpJsonLogger  LoggerBuilder ;

$ exception = new  Exception ( ' TestException ' , 500 );
$ context = [
    ' name '  => ' keitakn ' ,
    ' email ' => ' [email protected] ' ,
];

$ loggerBuilder = new LoggerBuilder ();
$ loggerBuilder -> setFileName ( $ this -> outputFileBaseName );
$ loggerBuilder -> setUseInDocker ( true );
$ logger = $ loggerBuilder -> build ();
$ logger -> critical ( $ exception , $ context );

Cuidado

NekonomokochanPhpJsonLoggerLogger é uma subclasse que estende MonologLogger

Você pode usá-lo como MonologLogger .

No entanto, para os métodos a seguir, você pode passar apenas classes que estendam Exception ou Error como argumentos.

NekonomokochanPhpJsonLoggerLogger::error()
NekonomokochanPhpJsonLoggerLogger::critical()
NekonomokochanPhpJsonLoggerLogger::alert()
NekonomokochanPhpJsonLoggerLogger::emergency()

Em caso de violação, NekonomokochanPhpJsonLoggerLogger lançará NekonomokochanPhpJsonLoggerInvalidArgumentException

Licença

MIT

Expandir

php json logger

php-json-logger

Começando

Instale o pacote compositor

Como usar

Uso básico

Como alterar o caminho do arquivo de saída

Como definir `trace_id`

Como alterar o nível de log

Como mudar de canal

Como alterar a data de rotação do log

Estenda e use `NekonomokochanPhpJsonLoggerJsonFormatter`

Notificação para Slack

Usar no Docker

Cuidado

Licença

php jwt

JSON Viewer

Ferramenta de formatação JSON

Versão oficial da ferramenta jsonização

versão oficial do pacote jar net.sf.json

Tutorial básico e prático do Ajax (incluindo exemplos de php json)

chat.petals.dev

GPT Prompt Templates

GPTyped

termwind

wp functions

slugify

waymo open dataset

termwind

wp functions

php json logger

php-json-logger

Começando

Instale o pacote compositor

Como usar

Uso básico

Como alterar o caminho do arquivo de saída

Como definir trace_id

Como alterar o nível de log

Como mudar de canal

Como alterar a data de rotação do log

Estenda e use NekonomokochanPhpJsonLoggerJsonFormatter

Notificação para Slack

Usar no Docker

Cuidado

Licença

Como definir `trace_id`

Estenda e use `NekonomokochanPhpJsonLoggerJsonFormatter`