Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: structured logging (JSON) #5118

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

SapphicCode
Copy link

@SapphicCode SapphicCode commented Sep 19, 2024

⚠️⚠️⚠️ Since we do not accept all types of pull requests and do not want to waste your time. Please be sure that you have read pull request rules:
https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma

Tick the checkbox if you understand [x]:

  • I have read and understand the pull request rules.

Description

Implements structured logging, as requested by #5107.
Resolves #5107

This feature can be enabled by using the environment variable UPTIME_KUMA_LOG_FORMAT set to json.

This PR also incorporates the work of #4391 and #4392 (with minor fixes to both as per the linter), for the feature itself I would direct your attention to commit 3e922be.

Closes #4391
Closes #4392

Type of change

Please delete any options that are not relevant.

  • User interface (UI)
  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Before

Code - 2024-09-19 10 24 23

After

Code - 2024-09-19 10 26 47

Checklist

  • My code follows the style guidelines of this project
  • I ran ESLint and other linters for modified files
  • I have performed a self-review of my own code and tested it
  • I have commented my code, particularly in hard-to-understand areas (including JSDoc for methods)
  • My changes generates no new warnings
  • My code needed automated testing. I have added them (this is optional task)

…log`

Co-authored-by: Frank Elsinga <[email protected]>
Closes: louislam#4391

Squashed commit of the following:

commit 828d2a7
Merge: 10f771c dd75890
Author: Frank Elsinga <[email protected]>
Date:   Fri Sep 13 22:51:25 2024 +0800

    Merge branch 'master' into deprecations

commit 10f771c
Author: Frank Elsinga <[email protected]>
Date:   Thu Jan 18 22:36:12 2024 +0100

    formatting fixes

commit d737b19
Author: Frank Elsinga <[email protected]>
Date:   Thu Jan 18 21:27:30 2024 +0100

    migrated all settings to use the `Settings` class

commit c5e26e9
Author: Frank Elsinga <[email protected]>
Date:   Thu Jan 18 21:04:44 2024 +0100

    removed the deprecated logging functionality
Co-authored-by: Frank Elsinga <[email protected]>
Closes: louislam#4392

Squashed commit of the following:

commit 75c4c35
Merge: 14e3c3c dd75890
Author: Frank Elsinga <[email protected]>
Date:   Fri Sep 13 22:46:21 2024 +0800

    Merge branch 'master' into unified-logging-infrastructure

commit 14e3c3c
Merge: d622dfb c919d2c
Author: Frank Elsinga <[email protected]>
Date:   Mon Jun 3 16:00:56 2024 +0200

    Merge branch 'master' into unified-logging-infrastructure

commit d622dfb
Author: Frank Elsinga <[email protected]>
Date:   Thu Jan 18 22:31:10 2024 +0100

    unified our logging infrastructure
Includes a slight refactor in the console logging section, to achieve an unformatted output and reduce complexity.

Resolves: louislam#5107
@SapphicCode SapphicCode changed the title feat: structured logging feat: structured logging (JSON) Sep 19, 2024
Resolves the following trace:

Trace: TypeError: Cannot convert object to primitive value
    at res.end (<snip>/uptime-kuma/server/modules/apicache/apicache.js:308:64)
    at ServerResponse.send (<snip>/uptime-kuma/node_modules/express/lib/response.js:233:10)
    at ServerResponse.json (<snip>/uptime-kuma/node_modules/express/lib/response.js:279:15)
    at module.exports.sendHttpError (<snip>/uptime-kuma/server/util-server.js:806:25)
    at <snip>/uptime-kuma/server/routers/status-page-router.js:58:9
    at process.unexpectedErrorHandler (<snip>/uptime-kuma/server/server.js:1858:13)
    at process.emit (node:events:519:28)
    at emitUnhandledRejection (node:internal/process/promises:250:13)
    at throwUnhandledRejectionsMode (node:internal/process/promises:385:19)
    at processPromiseRejections (node:internal/process/promises:470:17)
    at process.processTicksAndRejections (node:internal/process/task_queues:96:32)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Option to configure UPTIME_KUMA_LOG_FORMAT: json or text
1 participant