Keys of health check result json are complex strings instead of json

[christianwgd]

Hi, maybe I've missed something, but the keys in the json structure of the health check results are strings that are really ugly to parse, i.e. "Database(alias='default')". Is there are reason that those aren't proper json expressions or is there a way to parse them? Thanks for any hints.

[codingjoe]

Hi @christianwgd 👋,

Thanks for reaching out. I guess the big question is, what is proper?

They are keys; hence, they need to be a string. They need to be unique, in case someone adds multiple databases. We just rolled with __repr__, since dataclasses ship with great __repr__ support and that simplified the implementation.

If you have suggestions for improvement, send them my way. There isn't much logic behind it, except that it is built in and keeps the package complexity low.

Cheers!
Joe

[codingjoe]

Interesting, is that based of this package? This might somewhat exceed the current scope of this package.

[christianwgd]

Yes, indeed, it is. You can find the package here on GitHub: https://github.com/christianwgd/django-app-monitor.git

[janheussner]

Right now i am using Uptime Kuma to evaluate the json format but with the new Key in v. 4 it is kind of impossible.

Uptime Kuma is using this to evaluate the result and it looks like it is not supporting brackets and single-quotes
https://docs.jsonata.org/overview

My Test is this:
https://try.jsonata.org/E3r7sVntU

So i would also prefer the proposal of @christianwgd syntax or I have to create a workaround for this.
Or is there a chance for a setting which is replacing this characters with something else but also looks more like a workaround.

[codingjoe]

I wonder, why do the labels matter so much? Yes, they contain some identifiable information, but they are not meant as structured data.

To be honest, my current suggestion would be subclassing and implementing different __repr__ methods. Something like:

return json.dumps({
   field.name: getattr(self, field.name)
    for field in dataclasses.fields(self)
    if field.repr
}

However, I don't really want to change how Python decides to represent dataclasses and this package provides health checks and isn't a monitoring suite. This might go beyond the scope of this package.

[janheussner]

Okay I understand. Thanks for your answer and your effort :)