Logging

Overview

Access to logs is critical for building, deploying, and supporting integrations. If an alert monitor alerts your team to an instance behaving unexpectedly, your team needs to know precisely when an instance ran, the status of the instance's steps as they finished, and what happened if a step failed to run as expected. Prismatic provides access to logs of all instance invocations and tests.

Viewing Logs for All Customers

To see logs for all instances for all of your customers, click the Logs link on the left-hand sidebar. Here you will see log messages, their timestamps in your local time, the name of the instance, the name of the integration the instance was created from, and the name of the customer the instance was deployed to.

Viewing Logs for a Specific Customer

To view logs for a specific customer, click the Customers link on the left-hand sidebar. Click into a customer, and then select the customer's Logs tab. Here you will see log messages, their timestamps in your local time, the name of the instance, and the name of the integration the instance was created from.

For More Information: Customers

Viewing Logs for a Specific Instance

To view logs for a specific instance, access the instance either by clicking Instances on the left-hand sidebar and selecting an instance, or by clicking Customers on the left-hand sidebar, selecting a customer, and selecting an instance under the Instances tab. Once in an instance, select the Logs tab. Here you will see log messages, their timestamps in your local time, the name of the integration the instance was created from, and the name of the customer the instance was deployed to.

For More Information: Instances

Searching, Filtering, and Sorting Logs

You can search for specific messages in logs by typing part of the message into the Search Logs search bar on the top of any log page.

For more information on a specific log line, clicking the log line will bring up an additional information panel on the bottom of the screen.

Additionally, you can filter logs by Log Severity (Error, Warn, Info, Debug), by Timestamp, or by Integration by clicking the Filter drop-down to the right of the search bar.

Logs are sorted by Timestamp by default. To sort logs by Customer, Integration, Instance, or Message instead, click the corresponding heading once to sort in ascending order, or twice to sort in descending order.

Viewing Logs for an Integration Test

Within the integration designer, you can test your integrations as you build them. Logs for those tests are visible in the bottom-right pane under the Runner tab.

For More Information: Testing Integrations

What Gets Logged?

If a component invokes context.logger.{info,warn,error,fatal}() within its code, that log line is saved in Prismatic's logging system.

In addition to logs issuing from components, you will see the following types of log lines in your logs:

TypeExamplePurposeLog Level
Instance StartStarting Instance 'Sample Instance'Indicates the beginning of a run of an instance.info
Instance EndEnding Instance 'Sample Instance'Indicates that an instance ran successfully to completion.info
Step QueuedRunning step 2 with 2 pendingIndicates how many steps have run so far, and how many have yet to run. Logs between steps of an integration.info
Step StartedStarting action 'action-name' (aws-s3/putObject v2)Displays the name of the component, action, and component version associated with the step that was invoked.info
Step EndEnding action 'action-name' (aws-s3/putObject v2)Displays the name of the component, action, and component version of the step that has just completed running.info
Step Failed{{ERROR MESSAGE}}Indicates that a step of an instance failed to run, and displays the related error message.error

For More Information: context.logger

Log Levels

Prismatic components use the pino logger to emit log messages. Log levels that are included with pino are trace, debug, info, warn, error, and fatal, though trace and debug are ignored by the Prismatic logging service. info lines are presented in the web app with a blue dot next to them. warn messages are accompanied by yellow dots , and error and fatal are accompanied by red dots .

Last updated on