1"use strict";(globalThis.webpackChunkdocumentation=globalThis.webpackChunkdocumentation||[]).push([[9621],{7170(e,n,o){o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"opal-plus/troubleshooting","title":"Troubleshooting","description":"When something goes wrong, we are here to help.","source":"@site/docs/opal-plus/troubleshooting.mdx","sourceDirName":"opal-plus","slug":"/opal-plus/troubleshooting","permalink":"/opal-plus/troubleshooting","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":10,"frontMatter":{"sidebar_position":10,"title":"Troubleshooting"},"sidebar":"opalSidebar","previous":{"title":"Advanced Features","permalink":"/opal-plus/features"},"next":{"title":"FAQ","permalink":"/FAQ"}}');var i=o(1684),s=o(506);const r={sidebar_position:10,title:"Troubleshooting"},l=void 0,a={},c=[{value:"Seeking Support",id:"seeking-support",level:3},{value:"Extract Logs",id:"extract-logs",level:4},{value:"Export Configuration",id:"export-configuration",level:4},{value:"Common Issues",id:"common-issues",level:2}];function u(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"When something goes wrong, we are here to help."}),"\n",(0,i.jsxs)(n.p,{children:["Feel free to reach out to us on Slack on our ",(0,i.jsx)(n.a,{href:"https://bit.ly/opal-slack",children:"community channel"}),"\nor in your dedicated OPAL+ support channel, and we will do our best to assist you quickly."]}),"\n",(0,i.jsx)(n.h3,{id:"seeking-support",children:"Seeking Support"}),"\n",(0,i.jsx)(n.p,{children:"When seeking support, please provide as much information as possible to help us understand the issue and resolve it faster.\nThis includes:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Full description of the problem"}),"\n",(0,i.jsx)(n.li,{children:"Steps to reproduce the issue"}),"\n",(0,i.jsx)(n.li,{children:"Environment details (OS, Docker, Kubernetes, etc.)"}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"You can also provide the following information:"}),"\n",(0,i.jsx)(n.h4,{id:"extract-logs",children:"Extract Logs"}),"\n",(0,i.jsxs)(n.p,{children:["On production, we advise you to connect OPAL+ to your logging system to collect logs.\nConfigure the ",(0,i.jsx)(n.a,{href:"/getting-started/configuration",children:"OPAL_LOG_SERIALIZE"})," environment variable to ",(0,i.jsx)(n.code,{children:"true"})," to serialize logs in JSON format."]}),"\n",(0,i.jsxs)(n.p,{children:["When running OPAL+ locally or in a development environment, you can extract logs from the console.\nAlternatively, you can enable logging to file by setting the ",(0,i.jsx)(n.a,{href:"/getting-started/configuration",children:"OPAL_LOG_TO_FILE"})," to ",(0,i.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["You can also enable debug logs by setting the ",(0,i.jsx)(n.a,{href:"/getting-started/configuration",children:"OPAL_LOG_LEVEL"})," environment variable to ",(0,i.jsx)(n.code,{children:"debug"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"export-configuration",children:"Export Configuration"}),"\n",(0,i.jsx)(n.p,{children:"You can export your configuration by running the following command:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"opal-client print-config\n"})}),"\n",(0,i.jsx)(n.p,{children:"Make sure to censor any sensitive information, like passwords or API keys, before sharing the configuration."}),"\n",(0,i.jsx)(n.h2,{id:"common-issues",children:"Common Issues"}),"\n",(0,i.jsxs)(n.p,{children:["More common issues and their solutions are available in the ",(0,i.jsx)(n.a,{href:"/getting-started/running-opal/troubleshooting",children:"OPAL documentation"}),"."]})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},506(e,n,o){o.d(n,{R:()=>r,x:()=>l});var t=o(2888);const i={},s=t.createContext(i);function r(e){const n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.