OpenConext / OpenConext/OpenConext-oidcng

Make the json logging more suitable for ELK indexing

Open
#202 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Imported
Dominant language
Java
Stars
4
Forks
6
Avg merge
5d 32m
Merged PRs (30d)
3

Description

This issue is imported from pivotal - Originaly created at Dec 9, 2020 by Bart Geesink

Currently we have json logging, which enables us to send the errors to ELK. We use ELK to view what's happening when you release a new version, or to do analysis of certain incidents.
It is now difficult to do analysis, because the "message" does not contain enough information (only stuff like "error occured" or "Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception ". The other field with information is the stack trace itself.

I'd like to be able to get a field that I can use to aggregate and count what's happening.

So the field "message" would contain keywords, like
"missing_refresh_token"
"code_used_twice"
"no_access_token_found"
etc

This would allow us to see trends, and check for specific errors in certain RP's

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named. Start by locating the JSON logging configuration and the code paths that emit the example errors, then assess how the message field is consumed by ELK. Done means the relevant errors expose consistent, aggregatable message keywords without losing the existing stack-trace information.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch, java
Domain
backend, observability-sre
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.