Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

# Introduction
Velo's [site monitoring](https://support.wix.com/en/article/about-site-monitoring)
 feature lets you view, analyze, and debug logs. You can examine
 logs in real time, or connect Wix Logs to an external monitoring
 tool to generate log metrics and perform error log analysis.

## How It Works

 Velo's site monitoring tool records Wix logs as [log entries](site-monitoring.LogEntry.html).
 Each log entry is a JSON object representing a single log.

The following is an example of a `logEntry`:

 **Log Entry for Console Log in HTTP Function**

   ```javascript
    {
      "timestamp": "2019-03-31T06:02:12.008Z",
      "receiveTimestamp": "2019-03-31T06:02:12.925Z",
      "severity": "INFO",
      "insertId": "6axgiF6X45ftx7A1bjJBCh",
      "labels": {
        "siteUrl": "https://my-site.com",
        "namespace": "Velo",
        "tenantId": "fbd4e3c6-8e55-4098-b0ff-5e478b6c957e",
        "viewMode": "Site",
        "revision": "12"
      },
      "operation": {
        "id": "1554017373.14484058793726342",
        "producer": "httpFunction:myFunction",
      },
      "sourceLocation": {
        "file": "http-functions.js",
        "line": 14
      },
      "jsonPayload": {
        "message": "myFunction called."
      }
    }
   ```

 For a detailed description of the JSON representation of a log entry, click [here](site-monitoring.LogEntry.html).

## Viewing logs

 You can investigate your logs in the following ways:

 + **View logs in real time:** You can quickly scan basic log information or view the JSON object representing each log. 
   Logs are loaded as they occur. [Learn more](https://support.wix.com/en/article/viewing-live-site-events).
 + **Connect to Google Cloud Logs:** You can easily connect your site's logs to Google's external monitoring tool. 
   Google Cloud Logs performs log analysis and generates visual depictions of log data, 
   allowing you to extract meaningful insights 
   from your logs. [Learn more](https://support.wix.com/en/article/velo-connecting-wix-logs-to-google-cloud-logs).
 + **Connect to an external monitoring tool:** You can connect your Wix Logs to a 
   monitoring tool of your choice to generate metrics and 
   analyze logs. [Learn more](https://support.wix.com/en/article/velo-connecting-wix-logs-to-a-monitoring-tool-advanced).


To learn how to generate logs on your site, click [here](https://dev.wix.com/docs/develop-websites/articles/workspace-tools/testing-monitoring/testing-troubleshooting/testing-and-troubleshooting-your-code#debugging-with-logs).

velo-spi_site-monitoring

# Introduction
Note the following terminology:

 + **Log entry:** Single record of a Wix log.
 + **Log:** Collection of log entries associated with the same site and namespace.

 The following is an example of a `LogEntry`:

 **Log Entry for Console Log in HTTP Function**

   ```javascript
    {
      "timestamp": "2019-03-31T06:02:12.008Z",
      "receiveTimestamp": "2019-03-31T06:02:12.925Z",
      "severity": "INFO",
      "insertId": "6axgiF6X45ftx7A1bjJBCh",
      "labels": {
        "siteUrl": "https://my-site.com",
        "namespace": "Velo",
        "tenantId": "fbd4e3c6-8e55-4098-b0ff-5e478b6c957e",
        "viewMode": "Site",
        "revision": "12"
      },
      "operation": {
        "id": "1554017373.14484058793726342",
        "producer": "httpFunction:myFunction",
      },
      "sourceLocation": {
        "file": "http-functions.js",
        "line": 14
      },
      "jsonPayload": {
        "message": "myFunction called."
      }
    }
   ```

 > **Note:** Currently, you cannot add content to log entries. All log entry data is generated by Velo.

LogEntry

Unique identifier for the log entry.

Each log entry is assigned a unique ID. A log entry with the same `insertId` as another log entry indicates a duplicate.

insertId

string

jsonPayload

LogEntryJsonPayload

Additional information about the log entry.

labels

LogEntryLabels

Additional information about a potentially long-running operation associated with the log entry.

Some operations, such as an HTTP function call or a scheduled task, include
several log entries. The `operation` object lets you identify all log entries
associated with a specific operation via the operation ID, which is unique
to each operation.
You can also use the `producer` property to identify the context of the
operation, such as a URL path for page code or an HTTP function name.

 > **Note:** Currently only applicable for log entries with the `Velo` namespace.

operation

LogEntryOperation

Time the log entry was received by site monitoring.

Displayed as UTC time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.

receiveTimestamp

Severity of the log entry.

One of the following standard severity levels:

 + `"INFO"`: Status, performance, or other general information.
 + `"WARNING"`: An unexpected or undesired development that may cause problems.
 + `"ERROR"`: A serious issue that is likely to cause problems.

severity

Source code location information associated with the log entry.

Provides location information for source code associated with the log entry.

 > **Note:** Currently only applicable for backend log entries with the `Velo` namespace.

sourceLocation

LogEntrySourceLocation

Time the log occurred. Displayed as UTC time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.

timestamp

message

Name of Wix application with which the log entry is associated, such as Stores or Bookings. The generic namespace `Velo` represents site code not associated with a specific Wix application. Currently only the `Velo` namespace is supported.

namespace

Unique identifier for a specific site [`revision`](https://www.wix.com/velo/reference/wix-site.html#revision). You can use the `revision` property together with the [Release Manager](https://support.wix.com/en/article/about-site-monitoring#site-revisions) to monitor and debug new revisions of your site.

revision

[`baseUrl`](https://www.wix.com/velo/reference/wix-location.html#baseUrl) of the site with which the log entry is associated.

siteUrl

Unique identifier for the site. Does not change even if the site name or other site attributes change.

tenantId

Indicates the viewing mode from which the log entry originates.
 One of the following:

 + `"Preview"`: Preview mode.
 + `"Site"`: Published site mode.

viewMode

Unique identifier useful for linking together all log entries associated with a specific operation.

Context of the operation, such as a URL path for page code or a web module function name.