The "Logs" module within the Speed application is an indispensable component designed to capture, store, and manage critical information about the system's operations and transactions. It serves multiple purposes, including event recording, debugging, security monitoring, compliance, and enhancing overall system reliability.
Whether accessed via developer keys or the front-end application, the system logs meticulous details of every API call made, offering a complete view of interactions with the application's services.
Each log entry is rich in detail, featuring essential information such as timestamp, API endpoint or URL, request parameters, request headers, response details, user or client identification, and error information when applicable.
The logs functionality in the Speed application is designed to provide a detailed and real-time account of actions and transactions within the system. This not only aids in troubleshooting but also enables real-time monitoring and analysis of key activities occurring for an account in the system. Here's a breakdown of how our logging system operates:
- Chronological Ordering:
Log entries are organized chronologically based on the time they were created, ensuring a sequential listing of actions that aids in comprehending the history of activity.
- Mode Differentiation:
We keep separate log entries for test and live modes. This distinction enables users to easily analyze the system's behavior in different environments.
- API Version Integration:
The API version information on the log detail page is provided for the convenience of the user. By clicking on the API version, users will be redirected to the versioning section of the API reference documentation, which will provide further information about version they are using.
The Logs module allows you to capture and record important actions within your application. Logging activities are commonly initiated by user interactions, such as manually generating an event via the Speed API.
API Endpoint: Start by making a request to the designated API endpoint for triggering the event. This endpoint may vary depending on your specific implementation, but it should follow the general format of
Web App: Any action triggered by user in web application would also result in creating a log in their account.
Logs are accessible from Speed Web Application → Developer → Logs
This table serves as a comprehensive guide, detailing the different techniques employed by Speed to maintain a log associated with your account.
|When you manually trigger an action via Speed API.
|When you interact from Speed web application for any applicable resources
- Endpoint: The name of the URL endpoint where the request was made.
- Status: HTTP response status codes.
- ID: A unique identifier assigned to this specific request.
- Date created: The date and time when this particular request call occurred.
- IP Address: The IP address used to make the request.
- API version: The version date of the request.
- Source: The source or application that initiated the request call.
- Origin: The origin from which the request was generated.
In the Logs module, you can easily filter by resource ID to locate specific events or actions associated with a particular resource, such as a checkout session or any other Speed resource. Here are the steps to do so:
- Open the Logs Page.
- Locate the Filter by Resource ID Text Field.
- Enter the Resource ID (
- Apply the Filter and view Filtered Results.
The filtering options provided within the Logs module offer a powerful way to manage and troubleshoot in your Speed application. Here how to use them effectively:
- Date: You can begin by selecting any one date option shown from the list. This allows you to focus on requests that occurred within a defined time frame.
- Status: Users will have the convenience of choosing from three distinct log viewing options:
- All: By default, the filter setting will be preconfigured to "All" when the page view loads.
- Succeeded: All successful actions performed within an account will be displayed.
- Failed: All unsuccessful actions performed within an account will be displayed.
- Method: Select any one of the method i.e. GET, POST or DELETE to filter requests. This helps you isolate specific types of interactions, making it easier to troubleshoot or analyze particular endpoints.
- API endpoint: Use this option to filter requests by their API endpoint. Enter the endpoint URL to narrow down the requests associated with a particular API route or resource (/payment-page),(/checkout-sessions). Only one endpoint URL can be filtered at a time.