Difference between revisions of "Logs"
(Update for 2.3.1) (Tag: Visual edit) |
|||
| Line 1: | Line 1: | ||
| − | <big> | + | <big>The '''Logs''' page gives you a picture of all the of activity happening in your hub. Depending on your settings, app and device logs (events, automations, errors, etc.) may appear here. Watching your logs is one way to troubleshoot your devices or automations if things are not working as expected or to scan for errors or warnings.</big> |
| − | <big>It is best to open your logs in a separate window so you can watch them while you work on the Hubitat | + | <big>It is best to open your logs in a separate window (or tab) so you can watch them while you work on the Hubitat web in a second window. The default logs page, '''Current Logs''', starts blank, but data will begin to appear as your system generates log entries.</big> |
| − | <big>Let's take a look at a sample | + | == <big>Current Logs</big> == |
| − | [[File:Logs 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/d/dc/Logs_2.0.png]] | + | <big>Let's take a look at a sample logs page:</big>[[File:Logs 2.0.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/d/dc/Logs_2.0.png]]<big>The various parts of the interface include:</big> |
| − | <big> | ||
| − | <big>('''B''') This is the | + | * <big>'''A''': The specific type of log, statistics, history, etc. you are viewing. This is defaults to '''Current Logs''', shown above.</big> |
| + | * <big>'''B''': As new devices or apps show up in your logs, their names will also appear up here. Select on any device or app name up here and it will only display logs for that device/app. Select '''All''' to see all entries again.</big> | ||
| + | * <big>'''C''': The app or device ID (internally assigned by the hub but visible in the URL when editing a device or app). Selecting this will also filter the list by the correspding app or device, just like selecting '''B'''.</big> | ||
| + | * <big>'''D''': The date/time that the log entry was generated</big> | ||
| + | * <big>'''E''': The type of log entry, any of '''info''', '''debug''', '''trace''', '''warn''', or '''error'''. The '''info''' and '''debug''' types are generally normal and expected in some cases; '''error'''s and '''warning'''s may be of concern. See How to Collect Information for Support for more information.</big> | ||
| + | * <big>'''F''': The text of the log entry, often a device event or an action an app is taking.</big> | ||
| + | * <big>'''G''': Type text here to filter the list for entries that contain only the specified text (as any part of the log entry).</big> | ||
| + | * <big>'''H''': Select '''Pause''' to stop displaying additional log entries, even if apps or devices generate additional logs. This can be useful if you want to examine a specific log entry but lots of other data is coming in quickly. Select '''Resume''' (which this button will display when paused) to resume displaying new entries and any missed while paused.</big> | ||
| + | * <big>'''J''': Clears all log entries (items '''C''' through '''F''') from the display. Note that this affects page display only; logs remain on the hub and can be viewed under '''Past Logs''' until they are automatically purged.</big> | ||
| − | <big> | + | == <big>Past Logs</big> == |
| − | + | <big>Select '''Past Logs''' (labeled '''K''' below) to view a recent log history. Unlike '''Current Logs''', this page does not update in real time and contains only entries that existed at the time this page was loaded. See [[Past Logs]] for more.</big> | |
| − | <big> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 03:56, 25 March 2022
The Logs page gives you a picture of all the of activity happening in your hub. Depending on your settings, app and device logs (events, automations, errors, etc.) may appear here. Watching your logs is one way to troubleshoot your devices or automations if things are not working as expected or to scan for errors or warnings.
It is best to open your logs in a separate window (or tab) so you can watch them while you work on the Hubitat web in a second window. The default logs page, Current Logs, starts blank, but data will begin to appear as your system generates log entries.
Current Logs
Let's take a look at a sample logs page:
The various parts of the interface include:
- A: The specific type of log, statistics, history, etc. you are viewing. This is defaults to Current Logs, shown above.
- B: As new devices or apps show up in your logs, their names will also appear up here. Select on any device or app name up here and it will only display logs for that device/app. Select All to see all entries again.
- C: The app or device ID (internally assigned by the hub but visible in the URL when editing a device or app). Selecting this will also filter the list by the correspding app or device, just like selecting B.
- D: The date/time that the log entry was generated
- E: The type of log entry, any of info, debug, trace, warn, or error. The info and debug types are generally normal and expected in some cases; errors and warnings may be of concern. See How to Collect Information for Support for more information.
- F: The text of the log entry, often a device event or an action an app is taking.
- G: Type text here to filter the list for entries that contain only the specified text (as any part of the log entry).
- H: Select Pause to stop displaying additional log entries, even if apps or devices generate additional logs. This can be useful if you want to examine a specific log entry but lots of other data is coming in quickly. Select Resume (which this button will display when paused) to resume displaying new entries and any missed while paused.
- J: Clears all log entries (items C through F) from the display. Note that this affects page display only; logs remain on the hub and can be viewed under Past Logs until they are automatically purged.
Past Logs
Select Past Logs (labeled K below) to view a recent log history. Unlike Current Logs, this page does not update in real time and contains only entries that existed at the time this page was loaded. See Past Logs for more.
