Observability
Logs and metrics are often known as two of the three pillars of observability. These are powerful tools that, if understood well, can unlock the ability to build better systems.
Metrics
By integrating with the VGS Observability Metrics solution, you can stop switching between different tools looking for patterns in scattered data to figure out what went wrong. Observability Metrics surface the information needed to resolve issues or understand the effects of updates within your infrastructure in near real time. You can combine and group data to get a fully connected view of the relationship between data from your integration health and the behaviors and outcomes you’re monitoring.
How to Access Observability Metrics
VGS Observability Metrics provides a Prometheus pull-based API. Details on how to access the Prometheus API are available here.
Once you've established connectivity, you can query and view metric-related data by querying your Prometheus-based system.
Reference queries, metrics, and dimensions are available on the Metrics Definitions page.
Audit Logs
Audit Logs are a security-relevant chronological set of records that provide documentary evidence of the sequence of activities that have affected the configuration of your VGS Vault and any other related VGS Platform products. Each audit log entry contains the change to your configuration, the time, the actor, and related audit information.
How does it work
Audit logs are automatically collected from each API every time an API endpoint is called that results in a configuration change. This functionality is enabled by default and cannot be disabled.
How do I get them
Audit logs are available via the VGS Dashboard and can optionally be integrated into a third-party SIEM such as Splunk, Panther, Sumologic, or Elastic. Additionally, audit logs can be sent via webhook integrations.
How do I use them
Audit logs can be filtered by resource or user to allow you to find who made a change to the VGS Platform historically or in near real-time to monitor and react to events that may impact the security or compliance posture of your product.
Access Logs
Access logs are a chronological set of records that provide documentary evidence of traffic passing through your VGS Routes and Proxies. These records are generated any time a request or request analog (for non-request/reply-based protocols) is handled by a VGS Proxy. These records are typically used to understand the behavior of the system at an individual request level. If you wish to see aggregate information, it is more appropriate to use Metrics.
How does it work
Access logs are available via the VGS Dashboard and VGS CLI in near real-time (typically up to one minute of latency). Access logs contain metadata and timing information about each message passing through the proxy, but do not typically contain the actual payload of the message unless debug logging is enabled.
How do I get them
Access logs are available via the VGS Dashboard and VGS CLI in near real-time (typically up to one minute of latency) and can optionally be integrated into a third-party SIEM such as Splunk, Panther, Sumologic, or Elastic.
How do I use them
In the Sandbox environment, access logs can be enhanced by enabling debug logging, which records a full audit of the payload both before and after processing. This enables you to compare and debug the impact of your Route configuration, including any Functions that are applied to secure or compute on data in transit. Debug logging is enabled by visiting the logs section of the VGS dashboard.
Last updated