Skip to content

Obtaining Integration Logs

itchannel edited this page Oct 31, 2023 · 7 revisions

If debug logs are required or you are currently experiencing issues please follow the below process to provide these logs.

Logs may contain sensitive data so either please email me them direct github@itchannel.me or ensure you've sanitized them before attaching to a github issue.

Obtaining logs via debug button in integration

Step 1

In home assistant go the the integration page ({YOUR_HA_URL}/config/integrations/integration/fordpass)

Step 2

Click the Enable debug logging button in the below screenshot

image

Step 3

Repeat the activity that caused the error, if the issue occured in the past please just click the button again and it will provide all logs containing errors or warnings from the fordpass integration (Debug logs will generally not be included unless you did the activity whilst the button was enabled)

Step 4

Once you've clicked the button to disable Debug logging a .log file will be download in your browser, this contains the relevant log information we need to debug your issue.

Step 5

Please provide this file, ensuring it is either sanitized before uploading to an issue or sending to me privately.

Step 6

Create an issue on the github repo and provide the following information:

  • Model and year of Car
  • Version of the integration you are running
  • HA version
  • What is the issue you are experiencing
  • Link to log file or note to say you've sent it privately.

Obtaining logs via configuration.yaml

If experiencing issues installing or adding the integration then the following logging can be enabled in your configuration.yaml file to provide debug logs on install.

Step 1

Load up configuration.yaml in VScode or other file editor

Step 2

Add the following lines:

logger:
  default: warning
  logs:
    custom_components.fordpass: debug

As shown in the below screenshot

image

Step 3

Restart Home Assistant to apply changes and then try adding the integration.

Step 4

If you visit the general log page ({HOME_ASSISTANT_URL}/config/logs) you should see more verbose logging for the Fordpass integration

Step 5

Please provide this information as per Step 6 above.