[Home]

Summary:ASTERISK-29517: logger: JSON: add CEE fields or a generic template for JSON structure
Reporter:Daniel Pocock (daniel.pocock)Labels:
Date Opened:2021-07-10 10:30:09Date Closed:
Priority:MinorRegression?No
Status:Open/NewComponents:Core/Logging
Versions:18.5.0 Frequency of
Occurrence
Related
Issues:
Environment:allAttachments:
Description:JSON Structured logging was added in Asterisk 14, it is mentioned in the release notes and JIRA issue ASTERISK-25425

https://wiki.asterisk.org/wiki/display/AST/New+in+14
https://issues.asterisk.org/jira/browse/ASTERISK-25425

The wiki doesn't have any details about it:
https://wiki.asterisk.org/wiki/display/AST/Logging+Configuration

I found the template for the JSON fields here in the source code:
https://github.com/asterisk/asterisk/blob/master/main/logger.c#L270

It would be very useful to have the JSON CEE fields as an alternative.  They are described here:
https://cee.mitre.org/language/1.0-beta1/core-profile.html

When we are combining log events from different applications, it is useful if all the applications use the same field names.  The logs can be normalized by some other tool but it is more efficient if the preferred format is used from the source of the log messages.

I've recently done JSON CEE implementations for GStreamer, Kurento and reSIProcate processes:
https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/847
https://github.com/Kurento/kurento-media-server/pull/17
https://github.com/resiprocate/resiprocate/commit/d1df9aeb956be79253560fe3628b3f37a4ef94f2
Comments:By: Asterisk Team (asteriskteam) 2021-07-10 10:30:12.625-0500

Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution. Please note that log messages and other files should not be sent to the Sangoma Asterisk Team unless explicitly asked for. All files should be placed on this issue in a sanitized fashion as needed.

A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report.

Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process].

Please note that once your issue enters an open state it has been accepted. As Asterisk is an open source project there is no guarantee or timeframe on when your issue will be looked into. If you need expedient resolution you will need to find and pay a suitable developer. Asking for an update on your issue will not yield any progress on it and will not result in a response. All updates are posted to the issue when they occur.

Please note that by submitting data, code, or documentation to Sangoma through JIRA, you accept the Terms of Use present at [https://www.asterisk.org/terms-of-use/|https://www.asterisk.org/terms-of-use/].

By: Joshua C. Colp (jcolp) 2021-07-10 11:43:35.606-0500

Do you plan on contributing support for this? Otherwise this would be a feature request, which is not accepted on the issue tracker.

By: Asterisk Team (asteriskteam) 2021-07-24 12:00:03.542-0500

Suspended due to lack of activity. This issue will be automatically re-opened if the reporter posts a comment. If you are not the reporter and would like this re-opened please create a new issue instead. If the new issue is related to this one a link will be created during the triage process. Further information on issue tracker usage can be found in the Asterisk Issue Guidlines [1].

[1] https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines

By: Daniel Pocock (daniel.pocock) 2021-09-10 13:58:49.750-0500

Yes, I'm probably going to add this myself or collaborate with somebody else who will submit a patch

We did this in a few other projects already, it has just been completed and tested in Kamailio recently, Asterisk will be next

https://github.com/kamailio/kamailio/pull/2826

https://github.com/kamailio/kamailio/pull/2848

Obviously this is most useful when different applications (reSIProcate, Kamailio, Asterisk, GStreamer, Kurento) use a structure that is identical or as close as possible to identical.  Feel free to have a look at the Kamailio implementation and comment if you are happy for me to contribute something identical for Asterisk.

By: Asterisk Team (asteriskteam) 2021-09-10 13:58:50.456-0500

This issue has been reopened as a result of your commenting on it as the reporter. It will be triaged once again as applicable.

By: George Joseph (gjoseph) 2021-09-10 14:24:29.273-0500

Assigned to [~daniel.pocock] for now.