Skip to main content
Version: NG-3.1

Integration and Security

Integration with O11ySource​

OmniAgent acts as the execution layer in vuSmartMaps, responsible for applying configurations, deploying probes, and managing data collection across monitored hosts. In the ADI framework, monitoring configurations are defined at the platform level (such as through Host Landscape, environments, and host groups), and O11ySource provides supporting definitions for how telemetry data is collected. OmniAgent executes these configurations locally and ensures data is collected and reported back to the platform.

OmniAgent Discovery and Configuration Flow​

  • Install OmniAgent → Start OmniAgent → Host Registers with Platform →
  • Host appears in Host Landscape → Configuration evaluated →
  • Probes are initiated → Data collection begins → Monitoring status updated

How the Integration Works​

  • Configuration Creation: Users define or update data collection configurations within the vuSmartMaps platform (with O11ySource providing underlying configuration definitions where applicable)
  • Configuration Delivery: Once saved, these configurations are automatically delivered to the corresponding OmniAgent service on each host.
  • Execution: OmniAgent applies the configuration locally, deploys or updates probes, and initiates data collection as per the defined parameters.
  • Status Reporting: OmniAgent continuously reports probe health, configuration state, and data collection updates back to vuSmartMaps. These updates are visible in the Host Landscape and OmniAgent tab and the relevant configuration and monitoring views in the platform.
  • Synchronization: Any configuration updates or deletions made in O11ySources are automatically reflected within OmniAgent configuration state, ensuring both remain synchronized.
note

If OmniAgent is not installed or not reporting on a host, monitoring configurations cannot be applied and data collection will not begin. To enable monitoring, download and install OmniAgent, and start the service to allow the host to register with the platform.

Management Modes​

Depending on the configuration, data sources may be managed in different ways:

  • OmniAgent Managed: Automatically controlled by OmniAgent. Configurations are applied once the service is discovered and active on the host.
  • Manually Managed: The setup and configuration files are deployed manually on the host by the user.
  • Remote Collection: Data is gathered directly from remote systems without deploying OmniAgent locally.
info

The available management modes depend on the selected O11ySource. Only the supported modes appear during configuration. If OmniAgent is not installed, follow the OmniAgent installation steps.

Configuration Details​

For detailed steps on configuring O11ySources, including how to add, import, and manage data sources, refer to the working with O11ySources

This provides:

  • Step-by-step instructions for creating new data sources.
  • Details on importing and reviewing configurations.
  • Guidance on choosing between OmniAgent-managed, manual, and remote management modes.

Security Overview​

Security Considerations​

OmniAgent communicates securely with the platform and should be deployed according to organizational security policies.

Recommendations include:

  • Use TLS-secured communication.
  • Protect API keys from unauthorized access.
  • Restrict OmniAgent administrative access.
  • Regularly rotate credentials where required.
  • Validate certificates before deployment.
  • Monitor authentication failures and connectivity issues.

Control security​

OmniAgent communicates with the VuSmartMaps management platform using a TLS-encrypted TCP connection by default. This ensures that all control-plane communication—such as agent state reporting and update instructions—is protected against interception and tampering during transmission.

During deployment of the VuSmartMaps platform, a custom certificate file can be provided before OmniAgent installation. This certificate is packaged by default with all OmniAgent and probe packages. When present, the certificate is added to the set of trusted root certificate authorities used by OmniAgent to verify the server’s identity and establish a secure TLS connection.

This approach enables secure communication even in environments that use private certificate authorities or internally managed certificates.

TLS Configuration​

TLS behavior is configured through the OmniAgent configuration file using the tls section. This section allows administrators to control how server certificates are validated during secure communication.

# TLS configuration.
tls:
  # Path to certificate file directory. If not provided, system cert pool will
  # be used. Optional.
  certDirectory: "certs"
  # Skip TLS verification on errors.
  # Optional. Default: false
  insecureSkipVerify: false
  # Server name to use in TLS config. Required if certificate is provided.
  # Optional.
  serverName: "vunetsystems.com"
TLS Configuration Details​
  • Certificate Directory (certDirectory): Specifies the directory containing trusted certificate files. If not provided, OmniAgent uses the system’s default certificate trust store.
  • TLS Verification Control (insecureSkipVerify): Determines whether TLS verification errors should be ignored. By default, verification is enforced to ensure secure communication.
  • Server Name (serverName): Specifies the expected server name during TLS handshake. This is required when a custom certificate is provided to ensure proper certificate validation.

Security Benefits​

  • Ensures encrypted communication between OmniAgent and the management server
  • Prevents unauthorized servers from impersonating the VuSmartMaps platform
  • Supports custom and private CA environments
  • Centralizes TLS behavior through configuration, avoiding hard-coded security settings

Resource Control and Isolation​

OmniAgent is designed to operate with strict resource boundaries to ensure minimal impact on the host system and to prevent observability probes from consuming excessive resources.

OmniAgent Resource Limits​

OmniAgent runs with predefined resource limits to maintain a lightweight footprint on the host.

Hard Limits

  • CPU: 1 core
  • Memory: 250 MB

Idle State Consumption

  • CPU: Less than 0.01 core
  • Memory: Less than 30 MB

These limits ensure that OmniAgent remains efficient even when managing multiple probes.

Probe Resource Utilization Management​

OmniAgent actively manages the resource usage of individual probes to maintain system stability. Each probe operates within defined limits for:

  • CPU usage
  • Memory consumption
  • Log disk usage

Enforcement Behavior

If a probe exceeds its configured resource limits:

  1. OmniAgent stops the probe.
  2. The probe is restarted after a waiting period.
  3. The waiting period increases exponentially with each subsequent breach, up to a maximum of 10 minutes.
  4. If the probe remains within limits for 20 consecutive minutes, the waiting period is reset to its initial value.

This controlled restart mechanism prevents repeated resource exhaustion while allowing probes to recover automatically.

Probe Resource Configuration​

  • Probes are added with preconfigured resource limits by default.
  • Remote updates to probe resource limits will be supported directly from the platform in a future release.
  • To request changes to probe resource limits, contact VuSmartMaps Support.

Monitoring Resource Usage​

Both resource utilization and operational behavior of probes can be monitored from the Host Landscape:

These views help users identify resource-related issues, detect anomalies, and troubleshoot probe behavior.