How to do an optional argument in logging formatter










1















I would like to use the following log formatter:



'format': '"message": "%(message)s", "user": "%(user)s"'


However, I'd like to call it in two different ways:



log.info('hi', extra="user": str(request.user))
log.info("hi")


The first log statement works because it has the user kwarg, but the second one fails with a KeyError. Is there any way to make a formatting argument optional?










share|improve this question






















  • Off the top of my head I think you'll have to write yourself a custom Formatter that knows how to respond if it gets a KeyError, but there might be an easier way.

    – Adam Smith
    Nov 13 '18 at 22:17











  • What's wrong with extra="user": None?

    – Bakuriu
    Nov 13 '18 at 22:18











  • @Bakuriu sometimes I'll be calling this from outside the application -- so for backwards compatibility as well.

    – David L
    Nov 13 '18 at 22:19






  • 1





    See this CustomAdapter example in the logging cookbook. You can use self.extra.get('user') to default it to None when not supplied.

    – aneroid
    Nov 14 '18 at 1:40















1















I would like to use the following log formatter:



'format': '"message": "%(message)s", "user": "%(user)s"'


However, I'd like to call it in two different ways:



log.info('hi', extra="user": str(request.user))
log.info("hi")


The first log statement works because it has the user kwarg, but the second one fails with a KeyError. Is there any way to make a formatting argument optional?










share|improve this question






















  • Off the top of my head I think you'll have to write yourself a custom Formatter that knows how to respond if it gets a KeyError, but there might be an easier way.

    – Adam Smith
    Nov 13 '18 at 22:17











  • What's wrong with extra="user": None?

    – Bakuriu
    Nov 13 '18 at 22:18











  • @Bakuriu sometimes I'll be calling this from outside the application -- so for backwards compatibility as well.

    – David L
    Nov 13 '18 at 22:19






  • 1





    See this CustomAdapter example in the logging cookbook. You can use self.extra.get('user') to default it to None when not supplied.

    – aneroid
    Nov 14 '18 at 1:40













1












1








1








I would like to use the following log formatter:



'format': '"message": "%(message)s", "user": "%(user)s"'


However, I'd like to call it in two different ways:



log.info('hi', extra="user": str(request.user))
log.info("hi")


The first log statement works because it has the user kwarg, but the second one fails with a KeyError. Is there any way to make a formatting argument optional?










share|improve this question














I would like to use the following log formatter:



'format': '"message": "%(message)s", "user": "%(user)s"'


However, I'd like to call it in two different ways:



log.info('hi', extra="user": str(request.user))
log.info("hi")


The first log statement works because it has the user kwarg, but the second one fails with a KeyError. Is there any way to make a formatting argument optional?







python logging






share|improve this question













share|improve this question











share|improve this question




share|improve this question










asked Nov 13 '18 at 22:13









David LDavid L

38516




38516












  • Off the top of my head I think you'll have to write yourself a custom Formatter that knows how to respond if it gets a KeyError, but there might be an easier way.

    – Adam Smith
    Nov 13 '18 at 22:17











  • What's wrong with extra="user": None?

    – Bakuriu
    Nov 13 '18 at 22:18











  • @Bakuriu sometimes I'll be calling this from outside the application -- so for backwards compatibility as well.

    – David L
    Nov 13 '18 at 22:19






  • 1





    See this CustomAdapter example in the logging cookbook. You can use self.extra.get('user') to default it to None when not supplied.

    – aneroid
    Nov 14 '18 at 1:40

















  • Off the top of my head I think you'll have to write yourself a custom Formatter that knows how to respond if it gets a KeyError, but there might be an easier way.

    – Adam Smith
    Nov 13 '18 at 22:17











  • What's wrong with extra="user": None?

    – Bakuriu
    Nov 13 '18 at 22:18











  • @Bakuriu sometimes I'll be calling this from outside the application -- so for backwards compatibility as well.

    – David L
    Nov 13 '18 at 22:19






  • 1





    See this CustomAdapter example in the logging cookbook. You can use self.extra.get('user') to default it to None when not supplied.

    – aneroid
    Nov 14 '18 at 1:40
















Off the top of my head I think you'll have to write yourself a custom Formatter that knows how to respond if it gets a KeyError, but there might be an easier way.

– Adam Smith
Nov 13 '18 at 22:17





Off the top of my head I think you'll have to write yourself a custom Formatter that knows how to respond if it gets a KeyError, but there might be an easier way.

– Adam Smith
Nov 13 '18 at 22:17













What's wrong with extra="user": None?

– Bakuriu
Nov 13 '18 at 22:18





What's wrong with extra="user": None?

– Bakuriu
Nov 13 '18 at 22:18













@Bakuriu sometimes I'll be calling this from outside the application -- so for backwards compatibility as well.

– David L
Nov 13 '18 at 22:19





@Bakuriu sometimes I'll be calling this from outside the application -- so for backwards compatibility as well.

– David L
Nov 13 '18 at 22:19




1




1





See this CustomAdapter example in the logging cookbook. You can use self.extra.get('user') to default it to None when not supplied.

– aneroid
Nov 14 '18 at 1:40





See this CustomAdapter example in the logging cookbook. You can use self.extra.get('user') to default it to None when not supplied.

– aneroid
Nov 14 '18 at 1:40












0






active

oldest

votes











Your Answer






StackExchange.ifUsing("editor", function ()
StackExchange.using("externalEditor", function ()
StackExchange.using("snippets", function ()
StackExchange.snippets.init();
);
);
, "code-snippets");

StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "1"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);

else
createEditor();

);

function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);



);













draft saved

draft discarded


















StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53290302%2fhow-to-do-an-optional-argument-in-logging-formatter%23new-answer', 'question_page');

);

Post as a guest















Required, but never shown

























0






active

oldest

votes








0






active

oldest

votes









active

oldest

votes






active

oldest

votes















draft saved

draft discarded
















































Thanks for contributing an answer to Stack Overflow!


  • Please be sure to answer the question. Provide details and share your research!

But avoid


  • Asking for help, clarification, or responding to other answers.

  • Making statements based on opinion; back them up with references or personal experience.

To learn more, see our tips on writing great answers.




draft saved


draft discarded














StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53290302%2fhow-to-do-an-optional-argument-in-logging-formatter%23new-answer', 'question_page');

);

Post as a guest















Required, but never shown





















































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown

































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown







這個網誌中的熱門文章

Barbados

How to read a connectionString WITH PROVIDER in .NET Core?

Node.js Script on GitHub Pages or Amazon S3