context vs extras arguments #2

Activity

1. colinscape

   assigned

   erickhun

   on Nov 25, 2019
2. erickhun commented on Nov 25, 2019

   

   erickhun

   on Nov 25, 2019

   Last edited by erickhun

   Contributor

   More actions

   yeah @colinscape , @esclapes also bring up the exact same issue for the extra field . I've added the extra field after reading that documentation : https://docs.datadoghq.com/logs/log_collection/php/?tab=phpmonolog#adding-more-context

   As I understand That'd be some "extra" information that would not make sense to put in acontext .

   // Add various generic context
   $record['extra']['key'] = 'value';

   I've tried to come up with examples but can't 🤷‍♂️ So yeah we should certainly drop it if that doesn't make sense
3. colinscape commented on Nov 25, 2019

   

   colinscape

   on Nov 25, 2019

   Author

   More actions

   It looks from the implementation that everything gets put together anyway: https://github.com/bufferapp/php-bufflog/blob/master/src/php-bufflog/BuffLog.php#L94-L102

           $output = [
               "message"   => $message,
               "level"     => $level,
               "datetime"  => date(\DateTime::ATOM),
               // we could use timestamp if we need ms precision (but it isn't readable) https://docs.datadoghq.com/logs/processing/#reserved-attributes
               // 'timestamp' => round(microtime(true) * 1000),
               "context"   => $context,
               "extra"     => $extra
           ];
   

   From that, it doesn't look like there's any great difference - it's mainly the 'scope' of the information - I guess any parameters passed in the call will be more specific to the situation at hand (eg result of a function call), whereas the extra information would be the other stuff that might be useful for later analysis (eg, user id, trace id, span id, etc) and which would likely be shared across many of the logging calls from this service in this instance.
4. erickhun commented on Nov 26, 2019

   

   erickhun

   on Nov 26, 2019

   Contributor

   More actions

   

   😄React with 😄1Reacted by Colin Ross
5. erickhun commented on Nov 26, 2019

   

   erickhun

   on Nov 26, 2019

   Contributor

   More actions

   done with #6
6. erickhun

   closed this as completedon Nov 26, 2019
7. esclapes commented on Nov 27, 2019

   

   esclapes

   on Nov 27, 2019

   More actions

   I think that was a good call @erickhun, just for reference, I found this in monolog docs:

   At first glance context and extra look very similar, and they are in the sense that they both carry arbitrary data that is related to the log message somehow. The main difference is that context can be supplied in user land (it is the 3rd parameter to Logger::addRecord()) whereas extra is internal only and can be filled by processors. The reason processors write to extra and not to context is to prevent overriding any user provided data in context.

   It may be monolog specific, but it may be useful to keep it in mind if we consider move our convention to a monolog formatter
8. erickhun commented on Nov 28, 2019

   

   erickhun

   on Nov 28, 2019

   Contributor

   More actions

   yes @esclapes great find.

   I was reading how Monolog enrich information, and it use processors, that use by default the extra fields : some examples here: https://github.com/Seldaek/monolog/tree/master/src/Monolog/Processor

   I'm wondering if the information we're trying to add are only users related, so only using context 🤔
9. erickhun

   reopened this on Nov 29, 2019
10. brunojppb

    closed this as not plannedon Oct 1, 2026