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.

Sign up for GitHub

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

NMS-17070 Log messages from Groovy are truncated #7637

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

NMS-17070 Log messages from Groovy are truncated #7637

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6598478
NMS-17070 increase logs character size
Mohammad-Junid Feb 21, 2025
5df2e12
NMS-17070 re move change
Mohammad-Junid Feb 21, 2025
b10c25d
NMS-17070 re move change
Mohammad-Junid Feb 21, 2025
fb2839a
NMS-17070 change documents for change log size
Mohammad-Junid Mar 3, 2025
23042ce
NMS-17070 change in doc logs
Mohammad-Junid Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/modules/reference/pages/telemetryd/protocols/jti.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,47 @@ The following globals will be passed to the script:
| Decoded JTI message from which the metrics should be extracted.
| org.opennms.netmgt.telemetry.adapters.jti.proto.TelemetryTop
|===

NOTE: In OpenNMS, logs are essential for monitoring and troubleshooting. By default, the log message size is limited to 500 characters. However, in some cases, such as when viewing detailed proto object logs, you may need to increase the character size to capture the full log details.

=== Steps to Increase Log Character Size
Locate file `org.ops4j.pax.logging.cfg` in the `${OPENNMS_HOME}/etc/` directory.

Locate the `log4j2.pattern` property in the file. By default, it is set to limit log messages to 500 characters see `%encode{%.-500m}`

[source, console]
----
log4j2.pattern = %d{ISO8601} | %-5p | %-16t | %-32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %encode{%.-500m}{CRLF}%n
----
To increase the character size, modify the `%.-500m` part of the pattern. For example, to increase the limit to 1000 characters, change it to `%.-1000m`:
[source, console]
----
log4j2.pattern = %d{ISO8601} | %-5p | %-16t | %-32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %encode{%.-1000m}{CRLF}%n
----

=== Using Karaf Shell
You can also modify the `org.ops4j.pax.logging` configuration dynamically using the Karaf shell

Log in to the Karaf console in OpenNMS
[source, console]
----
ssh -p 8101 admin@localhost
----
Use the `config:edit` command to start editing the `org.ops4j.pax.logging` configuration
[source, console]
----
config:edit org.ops4j.pax.logging
----
Use the `config:property-set` command to update the `log4j2.pattern` property. For example, to increase the log message size to 1000 characters
[source, console]
----
config:property-set log4j2.pattern '%d{ISO8601} | %-5p | %-16t | %-32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %encode{%.-1000m}{CRLF}%n'
config:update
----

To verify that the changes have been applied, use the below command:
[source, console]
----
config:edit org.ops4j.pax.logging
config:property-get log4j2.pattern
----