Supported Target Versions
vRealize Log Insight version: 8.10.2-21145187

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
1.0.0Initial Deployment

Introduction

VMware vRealize Log Insight is a comprehensive operations management platform developed by VMware. It is designed to help organizations efficiently manage and monitor their virtualized and cloud environments. VMware vRealize Log Insight provides advanced analytics, automated workload balancing, capacity planning, performance optimization, and troubleshooting capabilities.

The platform collects data from various sources such as virtual machines, physical infrastructure, applications, and storage systems. It then analyzes the collected data to gain insights into the health, performance, and efficiency of the environment. These insights help IT administrators and infrastructure teams make informed decisions, proactively identify and resolve issues, optimize resource utilization, and ensure the overall performance and availability of their virtualized infrastructure.

Key features of VMware vRealize Log Insight include:

  • Performance Monitoring: Real-time monitoring and analysis of performance metrics to identify bottlenecks, optimize resource allocation, and ensure smooth operations.
  • Capacity Planning: Predictive analytics to forecast future resource requirements, identify capacity shortfalls, and optimize resource allocation to meet business demands.
  • Automated Remediation: Proactive identification and resolution of performance issues through automated actions, such as workload balancing and capacity adjustments.
  • Intelligent Workload Placement: Recommendations for optimal workload placement based on resource utilization, performance requirements, and business policies.
  • Customizable Dashboards and Reports: Creation of personalized dashboards and reports to visualize key performance indicators and monitor specific aspects of the infrastructure.
  • Integration with Ecosystem: Seamless integration with other VMware solutions, as well as third-party tools and management systems, to provide a unified operations management experience.

vRealize Log Insight simplifies the management of virtualized and cloud environments, enhances operational efficiency, and improves the performance, availability, and capacity planning of IT infrastructure.

Prerequisites

  • OpsRamp Classic Gateway 14.0.0 and above.
  • OpsRamp Nextgen Gateway 14.0.0 and above.
    Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc..
  • Should be able to connect to vRealize portal via SSH with the provided IpAddress/Hostname and the credentials.

Roles and Permissions

Users with read permissions are required to fetch service status related data.

Default Monitoring Configurations

VMware vRealize Log Insight has default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. Users can customize these default monitoring configurations as per their business use cases by cloning respective global templates and global Device Management Policies. OpsRamp recommends doing this activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for the Native Type of VMware vRealize Log Insight. You can find those Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names in global scope. Each Device Management Policy follows below naming convention:

    {appName nativeType - version}

    Ex: vmware-vrealize-log-insight VMware vRealize Log Insight - 1(i.e, appName = vmware-vrealize-log-insight, nativeType = VMware vRealize Log Insight , version = 1)

  2. Default Global Templates

    OpsRamp has a Global template for the Native Type of VMware vRealize Log Insight. You can find those templates at Setup > Monitoring > Templates, search with suggested names in global scope. Each template follows below naming convention:

    {appName nativeType 'Template' - version}

    Ex: vmware-vrealize-log-insight VMware vRealize Log Insight Template - 1(i.e, appName = vmware-vrealize-log-insight, nativeType = VMware vRealize Log Insight, version = 1)

  3. Default Global Monitors

    OpsRamp has a Global Monitors for the Native Type which has monitoring support. You can find those monitors at Setup > Monitoring > Monitors, search with suggested names in global scope. Each Monitors follows below naming convention:

    {monitorKey appName nativeType - version}

    Ex: VMware vRealize Log Insight Monitor vmware-vrealize-log-insight VMware vRealize Log Insight 1 (i.e, monitorKey =VMware vRealize Log Insight Monitor, appName = vmware-vrealize-log-insight, nativeType = VMware vRealize Log Insight , version = 1)

Configure and Install the VMWare vRealize Log Insight Integration

  1. From All Clients, select a client.
  2. Go to Setup > Integrations and Apps.
  3. The INSTALLED INTEGRATIONS page, where all the installed applications are displayed.
    Note: If there are no installed applications, it will navigate to the ADD APP page.
  1. Click + ADD on the INSTALLED INTEGRATIONS page. The AVAILABLE INTEGRATIONS AND APPS page displays all the available applications along with the newly created application with the version.
    Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.
  1. Click ADD in the VMware vRealize Log Insight application.
  2. In the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned BASIC INFORMATION:
FunctionalityDescription
NameEnter the name for the configuration.
VMware vRealize Log Insight IP Address/Host NameIP address/host name of the target.
API PortAPI Port details
Note: By default 9543 is added
API CredentialsSelect the Credential from the drop-down list.

Notes:
  • Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Enter the following information.
    • Name: Credential name.
    • Description: Brief description of the credential.
    • User Name: User name.
    • Password: Password.
    • Confirm Password: Confirm password
SSH PortSSH Port details
Note: By default 22 is added
SSH CredentialSelect the Credential from the drop-down list.

Notes:
  • Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Enter the following information.
    • Name: Credential name.
    • Description: Brief description of the credential.
    • User Name: User name.
    • Password: Password.
    • Confirm Password: Confirm password
Ports to be monitoredEnter the Ports that need to be monitored.
Note: By default 123, 25, 3269, 443, 53, 636, 6514, 9000, and 9543 are added.

Notes:

  • By default the Is Secure checkbox is selected.
  • VMware vRealize Log Insight IP Address/Host Name and Port should be accessible from Gateway.
  • Select the following:
    • App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
    • API Timeouts: These are the maximum API Timeouts that the application can use to connect and get responses from the end device.
      • Connection Timeout in Secs: a time period in which a client should establish a connection with a server.
        Note: By default, 60 is selected.
      • Connection Request Timeout in Secs: a time period required to process an HTTP call: from sending a request to receiving a response.
        Note: By default, 10 is selected.
      • Socket Timeout in Secs: a maximum time of inactivity between two data packets when exchanging data with a server.
        Note: By default, 10 is selected.
  1. Select the below mentioned Custom Attribute:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect the value from the drop down list box.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it. From the same page, you may Edit and Remove the created configuration.

  1. Click Next.

  2. Below are the optional steps you can perform on the Installation page.

    • Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

      Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

    • Click +ADD to create a new collector by providing a name or use the pre-populated name.
  1. Select an existing registered profile.
  1. Click FINISH.

The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

View the VMware vRealize Log Insight Details

The VMware vRealize Log Insight integration is displayed in the Infrastructure > Resources > Server. You can navigate to the Attributes tab to view the discovery details and Metrics tab to view the metric details for VMware vRealize Log Insight.

View Resource Metrics

To confirm VMware vRealize Log Insight monitoring, review the following:

  • Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
  • Alerts: Alerts are generated for metrics that are configured as defined for integration.

Resource Filter Input Keys

VMware vRealize Orchestrator application Resources are filtered and discovered based on below keys.

Click here to view the Supported Input Keys
Resource TypeSupported Input Keys
All TypesresourceName
hostName
ipAddress

Supported Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alerts based on customisation.
Supported macros keys:

Click here to view the alert subject and description with macros

                                ${resource.name}

                                ${resource.ip}

                                ${resource.type}

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
VMWare vRealize Log Insightvmware_vrealize_log_insight_port_StatusVMware vRealize Operations Port StatusNone1.0.0VMware vRealize Log Insight port open/close status
vmware_vrealize_log_insight_service_StatusVMware vRealize Log Insight Service StatusNone1.0.0VMware vRealize Log Insight system services running status
vmware_vrealize_log_insight_url_StatusVMware vRealize Log Insight URL StatusNone1.0.0VMware vRealize Log Insight URL reachability Status

Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure alert notifications for below two cases when user enables Notification Alert in configuration
    • Connectivity Exception
    • Authentication Exception
  • Application will not send any duplicate/repeat failure alert notification until the already existed critical alert is recovered.
  • Application cannot control monitoring pause/resume actions based on above alerts. Metrics can be used to monitor Vmware vRealize Log Insight resources and can generate alerts based on the threshold values.
  • OpsRamp has provided 22 as default SSH Port value for connecting to VRLI end device via SSH. Users can modify this value from the application configuration page at any point of time if required.
  • Specify the ports that require monitoring in the Ports to be Monitored section. By default, we are providing the following ports in this field: 123, 25, 3269, 443, 53, 636, 6514, 9000, and 9543.
  • Component level thresholds can be configured on each resource level.
  • No support of showing activity log and applied time. Latest snapshot metric support from Gateway 14.0.0.