docs(kic): add konnect integration troubleshooting section #7853
+16
−0
Conversation
This file contains 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
czeslavo
added
the
review:general
✅ Deploy Preview for kongdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
lena-larionova
requested changes
Sep 23, 2024
| @@ -359,3 +359,19 @@ kong admin` for configuration push failures. | |||
| {{ site.kic_product_name }} provides Kubernetes Events to help understand the state of your system. Events occur when an invalid configuration is rejected by {{ site.base_gateway }} (`KongConfigurationApplyFailed`) or when an invalid configuration such as an upstream service that does not exist is detected (`KongConfigurationTranslationFailed`).. | |||
|
|
|||
| For more information, see [Events](/kubernetes-ingress-controller/{{ page.release }}/production/observability/events/). | |||
|
|
|||
| ### Debugging Konnect integration | |||
There was a problem hiding this comment.
Suggested change
| ### Debugging Konnect integration | |
| {% if_version gte:3.3.x %} | |
| ### Debugging {{ site.konnect_short_name }} integration |
|
|
||
| ### Debugging Konnect integration | ||
|
|
||
| {{ site.kic_product_name }} needs to communicate with the Konnect cloud APIs to provide the [integration](/konnect/gateway-manager/kic). |
There was a problem hiding this comment.
Suggested change
| {{ site.kic_product_name }} needs to communicate with the Konnect cloud APIs to provide the [integration](/konnect/gateway-manager/kic). | |
| {{ site.kic_product_name }} needs to communicate with the {{ site.konnect_short_name }} cloud APIs to provide the [integration](/konnect/gateway-manager/kic). |
| ### Debugging Konnect integration | ||
|
|
||
| {{ site.kic_product_name }} needs to communicate with the Konnect cloud APIs to provide the [integration](/konnect/gateway-manager/kic). | ||
| If you encounter an issue with that, you should first inspect logs from {{ site.kic_product_name }} to identify the root cause. |
There was a problem hiding this comment.
Suggested change
| If you encounter an issue with that, you should first inspect logs from {{ site.kic_product_name }} to identify the root cause. | |
| If you encounter issues with KIC in {{ site.konnect_short_name }}, you should first inspect logs from {{ site.kic_product_name }} to identify the root cause. |
Comment on lines
+368
to
+370
| From {{ site.kic_product_name }} v3.3.0, KIC logs every failed request/response's details (method, URL, status code) it | ||
| receives from Konnect. Also, if you set the `LOG_LEVEL` to `trace`, {{ site.kic_product_name }} will log _every_ | ||
| request/response details it receives from Konnect. |
There was a problem hiding this comment.
Suggested change
| From {{ site.kic_product_name }} v3.3.0, KIC logs every failed request/response's details (method, URL, status code) it | |
| receives from Konnect. Also, if you set the `LOG_LEVEL` to `trace`, {{ site.kic_product_name }} will log _every_ | |
| request/response details it receives from Konnect. | |
| By default, KIC logs the details for every failed request and response (method, URL, status code) it | |
| receives from {{ site.konnect_short_name }}. If you set the `LOG_LEVEL` to `trace`, {{ site.kic_product_name }} will log the details for _every_ request and response it receives from {{ site.konnect_short_name }}. |
| Request failed {"x_b3_traceid": "66c731200000000034ce3297e8e64544", "x_b3_spanid": "4e6955874299011d", "x_datadog_trace_id": "3805034363203503428", "x_datadog_parent_id": "5650141246939267357", "v": 0, "method": "GET", "url": "https://us.kic.api.konghq.tech/kic/api/control-planes/81bc4af5-ed3c-40b4-bb88-b5a05fbe34a1/oauth2?size=1000", "status_code": 404} | ||
| ``` | ||
|
|
||
| If your issue requires further investigation on the Konnect side, please attach logs with tracing information to your support ticket. |
There was a problem hiding this comment.
Suggested change
| If your issue requires further investigation on the Konnect side, please attach logs with tracing information to your support ticket. | |
| If your issue requires further investigation on the {{ site.konnect_short_name }} side, attach logs with tracing information to your support ticket. | |
| {% endif_version %} |
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.
Description
Adds a Konnect integration section to the troubleshooting guide.
Testing instructions
Preview link: https://deploy-preview-7853--kongdocs.netlify.app/kubernetes-ingress-controller/latest/reference/troubleshooting/#debugging-konnect-integration
Checklist