Téléchargement php json logger - Téléchargement du code source php json logger

php-json-logger

LoggingLibrary pour PHP. Sortie au format JSON

Cette bibliothèque est principalement destinée à être utilisée dans les applications Web.

Commencer

Installer le package du compositeur

 composer require nekonomokochan/php-json-logger

Comment utiliser

Utilisation de base

 <?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 );

Il est affiché comme suit.

{
    "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
}

L'unité de process_time est ms (milliseconde).

Comment changer le chemin du fichier de sortie

Le chemin du fichier de sortie par défaut est /tmp/php-json-logger-yyyy-mm-dd.log .

Si vous souhaitez modifier le chemin du fichier de sortie, veuillez définir le chemin du fichier de sortie sur la classe de générateur.

 <?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 );

Le chemin du fichier de sortie est /tmp/test-php-json-logger-yyyy-mm-dd.log .

Il est affiché comme suit.

{
    "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
}

Comment définir `trace_id`

N'importe quelle valeur peut être définie pour trace_id .

Cela vous aidera lorsque vous rechercherez les journaux souhaités.

 <?php
use Nekonomokochan  PhpJsonLogger  LoggerBuilder ;

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

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

Il est affiché comme suit.

{
    "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
}

Comment changer le niveau de journalisation

Veuillez utiliser NekonomokochanPhpJsonLoggerLoggerBuilder::setLogLevel() .

Par exemple, le code suivant ne génère pas de journaux.

Parce que le niveau est défini sur CRITICAL .

 <?php
use Nekonomokochan  PhpJsonLogger  LoggerBuilder ;

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

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

Vous pouvez définir les valeurs suivantes pour logLevel .

Ce sont les mêmes que logLevel défini dans Monolog.

DÉBOGAGE = 100
INFOS = 200
AVIS = 250
AVERTISSEMENT = 300
ERREUR = 400
CRITIQUE = 500
ALERTE = 550
URGENCE = 600

Comment changer de chaîne

Le canal par défaut est PhpJsonLogger .

Si vous souhaitez changer de chaîne, vous pouvez la changer avec le code suivant.

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

Par exemple, le résultat est le suivant.

{
    "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
}

Comment modifier la date de rotation du journal

Il s'agit du paramètre par défaut pour enregistrer les journaux pendant 7 jours.

Si vous souhaitez modifier la date de rotation du journal, vous pouvez la modifier avec le code suivant.

Le code suivant définit la période de conservation des journaux sur 2 jours.

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

Étendre et utiliser `NekonomokochanPhpJsonLoggerJsonFormatter`

Vous pouvez créer votre propre MonologLogger en utilisant uniquement NekonomokochanPhpJsonLoggerJsonFormatter .

Cette méthode est utile lorsque vous avez besoin MonologLogger dans un framework d'application Web (par exemple Laravel).

Ce qui suit est un exemple de code.

 <?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 );

Il est affiché dans extended-monolog-test-yyyy-mm-dd.log comme suit

{
    "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
}

Le code suivant est nécessaire pour générer trace_id et process_time .

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

    return $ record ;
};

Le code ci-dessous est le code nécessaire pour afficher normalement la trace de pile avec JSON.

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

Pour afficher la trace de la pile dans le journal, exécutez le code suivant.

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

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

Veuillez faire attention à la partie $this->formatPhpJsonLoggerErrorsContext($exception, $context) .

Il s'agit d'un traitement nécessaire pour formater le journal des erreurs en JSON et le générer.

C'est la méthode implémentée dans NekonomokochanPhpJsonLoggerErrorsContextFormat .

Il est généré dans extended-monolog-test-yyyy-mm-dd.log comme suit.

Si vous souhaitez connaître une utilisation plus détaillée, veuillez consulter 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() "
        ]
    }
}

Notification à Slack

Pour envoyer le journal à Slack, veuillez exécuter le code suivant.

Ce code sera envoyé à Slack si le niveau de journalisation est CRITICAL ou supérieur.

 <?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 );

Utiliser dans Docker

Veuillez utiliser LoggerBuilder.setUseInDocker afin de l'utiliser sur Docker.

Lorsque setUseInDocker est défini sur true, aucune sortie de fichier n'est effectuée et le journal est généré sous la forme 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 );

Prudence

NekonomokochanPhpJsonLoggerLogger est une sous-classe qui étend MonologLogger

Vous pouvez l'utiliser comme MonologLogger .

Cependant, pour les méthodes suivantes, vous ne pouvez transmettre que les classes qui étendent Exception ou Error comme arguments.

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

En cas de violation, NekonomokochanPhpJsonLoggerLogger lancera NekonomokochanPhpJsonLoggerInvalidArgumentException

Licence

MIT

Développer

php json logger

php-json-logger

Commencer

Installer le package du compositeur

Comment utiliser

Utilisation de base

Comment changer le chemin du fichier de sortie

Comment définir `trace_id`

Comment changer le niveau de journalisation

Comment changer de chaîne

Comment modifier la date de rotation du journal

Étendre et utiliser `NekonomokochanPhpJsonLoggerJsonFormatter`

Notification à Slack

Utiliser dans Docker

Prudence

Licence

php jwt

JSON Viewer

Outil de formatage JSON

Version officielle de l'outil de jsonisation

version officielle du package jar net.sf.json

Bases d'Ajax et tutoriel pratique (y compris des exemples 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

Commencer

Installer le package du compositeur

Comment utiliser

Utilisation de base

Comment changer le chemin du fichier de sortie

Comment définir trace_id

Comment changer le niveau de journalisation

Comment changer de chaîne

Comment modifier la date de rotation du journal

Étendre et utiliser NekonomokochanPhpJsonLoggerJsonFormatter

Notification à Slack

Utiliser dans Docker

Prudence

Licence

Comment définir `trace_id`

Étendre et utiliser `NekonomokochanPhpJsonLoggerJsonFormatter`