Logging 101

The Summit logging library allows you to send messages to the application logs. This is primarily intended for debugging and troubleshooting after the fact, and is not intended to function as a form of reporting.

NOTE: Logs will not be kept forever, so if you need a permanent record of every run of your application, this does not provide that facility.

Modes

Whenever you call Summit Library functions (channel.say, http.get, email.send, etc.) the platform will log a helpful message, which includes what function was called and what the arguments were. However, sometimes you may want to turn down or disable this, in case you have sensitive arguments (like credit card numbers), and for that reason we allow you to set a logging mode.

By default, this mode is “verbose”, which means we log function names and full argument lists. We also provide a “restricted” mode, which still logs function calls but excludes their arguments. If that’s not enough, there’s a “silent” mode, which logs nothing. We recommend using this mode as little as possible, as turning off logging will make debugging and troubleshooting considerably harder. Additionally, these modes affect our platform internal logging as well, so when you turn on silent mode, we will not be able to retrieve log information about the specific progress of your call.

NOTE: These messages will show up in your application logs. We do not recommend logging sensitive data, such as credit card information, with this library.

Levels

In addition to the default messages described above, you can log your own messages at four different levels: debug, error, info, warning. Debug is the lowest level and is useful for finding issues. Info is the second lowest level available, where most automated logging of Summit Library functions occurs. Warning is the second highest level, which is used to alert you to potential problems. Error is the highest level, and is usually reserved only for major problems.

Accessing Logs

Summit Account: Application logs are available in your Summit Account by going to Logs -> Calls and clicking the plus sign to expand the row. From there, you can click the "View Application Log" icon on a call log to get a shortcut to all logs available for that call.

REST API: Logs are available via a GET request to the Application Logs endpoint. You'll need an API Key and Secret Key, which can be generated in your Summit Account.