Feature flag to add timestamp_real (#23)

README.md

@@ -570,6 +570,7 @@ Notes:
 
  * Use class `\JBZoo\Cli\Codes` to get all available exit codes.
  * You can add extra context to any message. It will be serialized to JSON and displayed in the end of the message. Just use `CliHelper::getInstance()->appendExtraContext(['section' => ['var' => 'value']]);`
+ * You can define constant `\JBZOO_CLI_TIMESTAMP_REAL=true` to add `timestamp_real` as exta context. Sometimes it's useful for logstash if default value `@timestamp` doesn't work for you.
 
 
 ## Contributing

src/OutputMods/Logstash.php

@@ -22,6 +22,7 @@
 use JBZoo\Cli\ProgressBars\AbstractProgressBar;
 use JBZoo\Cli\ProgressBars\ProgressBarLight;
 use JBZoo\Utils\Slug;
+use Monolog\DateTimeImmutable;
 use Monolog\Formatter\LogstashFormatter;
 use Monolog\Handler\StreamHandler;
 use Monolog\Level;
@@ -134,6 +135,16 @@ protected function printMessage(
 
     protected function prepareContext(array $context): array
     {
+        // We use timestamp_real to use the value from it in @timestamp using the rules of the logstash service.
+        // In cases if the default field `@timestamp` doesn't work with the logstash service for some reason.
+        if (
+            \defined('JBZOO_CLI_TIMESTAMP_REAL')
+            && JBZOO_CLI_TIMESTAMP_REAL
+            && !isset($context['timestamp_real'])
+        ) {
+            $context['timestamp_real'] = new DateTimeImmutable(true, new \DateTimeZone(\date_default_timezone_get()));
+        }
+
         $newContext = [
             'trace'   => ['id' => CliHelper::createOrGetTraceId()],
             'profile' => $this->getProfileInfo(),

tests/CliOutputLogstashTest.php

@@ -49,6 +49,7 @@ public function testFormatOfMessage(): void
                     'time_total_ms'     => 'double',
                     'time_diff_ms'      => 'double',
                 ],
+                'timestamp_real' => 'string',
             ],
         ], $lineStruture);
     }
@@ -97,6 +98,7 @@ public function testFormatOfMessageVerboseFisrt(): void
                     'process_command'   => 'string',
                     'working_directory' => 'string',
                 ],
+                'timestamp_real' => 'string',
             ],
         ], $lineStruture);
     }
@@ -127,14 +129,16 @@ public function testFormatOfMessageVerboseLast(): void
                     'time_total_ms'     => 'double',
                     'time_diff_ms'      => 'double',
                 ],
-                'process' => ['exit_code' => 'integer'],
+                'process'        => ['exit_code' => 'integer'],
+                'timestamp_real' => 'string',
             ],
         ], $lineStruture);
     }
 
     public function testFormatOfMessageException(): void
     {
         $cmdResult = Helper::executeReal('test:output', ['output-mode' => 'logstash', 'exception' => 'Some message']);
+        dump($cmdResult);
 
         $lineAsArray  = Helper::prepareLogstash($cmdResult->std)[9]->getArrayCopy();
         $lineStruture = self::replaceValues($lineAsArray);
@@ -166,6 +170,7 @@ public function testFormatOfMessageException(): void
                     'file'        => 'string',
                     'stack_trace' => 'string',
                 ],
+                'timestamp_real' => 'string',
             ],
         ], $lineStruture);
     }

tests/TestApp/bin.php

@@ -26,6 +26,8 @@
     \define('JBZOO_PATH_BIN', JBZOO_PATH_ROOT . '/' . \pathinfo(__FILE__, \PATHINFO_BASENAME));
 }
 
+\define('JBZOO_CLI_TIMESTAMP_REAL', true);
+
 require '../../vendor/autoload.php';
 
 $application = new CliApplication('Dummy App', '@git-version@');