[Logging] : Adding more information to error messages
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 970
- Forks
- 486
- Avg merge
- 3d 33m
- Merged PRs (30d)
- 170
Description
Parent Issue
No response
Task
Add more information and context to logged errors. In this method:
More information about:
- The Contentlet.
- The field.
- The value of such a field.
Must be logged.
Proposed Objective
Core Features
Proposed Priority
Priority 2 - Important
Acceptance Criteria
Provide more information on situations in which dotCMS is not able to handle user-entered data. This was found when troubleshooting a support ticket, and don't have any steps to reproduce it.
External Links... Slack Conversations, Support Tickets, Figma Designs, etc.
Assumptions & Initiation Needs
No response
Quality Assurance Notes & Workarounds
No response
Sub-Tasks & Estimates
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in dotCMS/src/main/java/com/dotcms/content/elasticsearch/business/ESContentletAPIImpl.java around lines 7185-7190 and inspect the existing error logging. Ensure the logged error includes context about the Contentlet, field, and field value. Done means these details are available when dotCMS cannot handle user-entered data; no reproduction steps or test file are provided.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100