Added troubleshooting page for license check failures#429
Open
zzzeebra wants to merge 1 commit into
Open
Conversation
…ures New page listing canonical License Server client errors (INVALID_LICENSE_SECRET 101, INVALID_LICENSE_CHECK_SECRET 107, CONNECTION_ERROR 400, PKIX SSL trust failure, GENERAL_ERROR) with diagnostic steps and per-code recovery instructions. Documents the new ERROR banner format, container exit code semantics, and the docker-compose restart: on-failure recommendation that avoids the infinite restart loop on unresolved license errors. Linked from the prerequisites section of what-is-license-server.mdx where the "may shut down" behavior was previously only vaguely mentioned. Added a Troubleshooting group to the License Server sidebar.
zzzeebra
force-pushed
the
docs/license-server-troubleshooting
branch
from
088d31c to
ce46717
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds operational documentation for diagnosing and recovering from ThingsBoard PE License Server client validation failures, and integrates that new content into the existing License Server docs navigation.
Changes:
- Adds a new troubleshooting page documenting the log banner pattern, common license-check failure codes, and recovery steps.
- Adds a link from the License Server prerequisites section to the troubleshooting page for quick operator guidance.
- Updates the License Server sidebar to include a new “Troubleshooting” group.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/content/docs/docs/license-server/what-is-license-server.mdx | Adds a link from prerequisites to the new troubleshooting page. |
| src/content/docs/docs/license-server/troubleshooting.mdx | Introduces a new page covering failure banner detection, error codes, remediation steps, and container restart behavior. |
| astro.sidebar.ts | Adds the troubleshooting page to the License Server sidebar navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The License Server Client (e.g. your ThingsBoard PE instance) requires an internet connection to the host `license.thingsboard.io` to issue license check requests. | ||
| In case internet connection to the host is not available for more than 24 hours, License Server Client may shut down the ThingsBoard instance. | ||
|
|
||
| If the License Server Client fails to validate the license, the ThingsBoard PE node logs a `*** LICENSE CHECK FAILED ***` banner on the ERROR level and exits with a non-zero JVM code. See [Troubleshooting license check failures](/docs/license-server/troubleshooting/) for diagnostic steps and recovery per error code. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new docs page documenting how License Server client failures manifest in ThingsBoard PE logs, and how to fix each canonical error code.
The existing
what-is-license-server.mdxonly vaguely says the client "may shut down the ThingsBoard instance" — leaving operators to debugINVALID_LICENSE_SECRET(101),INVALID_LICENSE_CHECK_SECRET(107),CONNECTION_ERROR(400), and PKIX/SSL failures from scratch. This page lists each mode with a concrete recovery procedure.Changes
docs/license-server/troubleshooting:*** LICENSE CHECK FAILED ({code} - code {n}) ***and a grep example to locate it across logs.-1→ POSIX255).restart: on-failurerecommendation that avoids the infinite-restart-loop symptom.what-is-license-server.mdx(right where the "may shut down" mention is).Troubleshootinggroup in the License Server sidebar.Companion PR
Backend PR introducing the ERROR banner the page references: thingsboard/thingsboard-pe#4799.
Test plan
npm run buildclean (3818 pages, no errors related to the new content)