Supported Versions
SunOS-5.9 OS
SunOS 5.11 Oracle Solaris 11.3 x86

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
6

Introduction

Solaris is a proprietary operating system which is provided by Oracle Corporation. It is a Unix-like operating system. It uses a mixed-source model, which includes both open and closed source components. This operating system uses a monolithic kernel with dynamically loadable modules.

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.
  • Provided IP Address/Host Name, Credentials should work for SSH communication.
  • Users should have read permissions for files /dev/mem, /dev/kmem. In order to fetch below metrics:
    • solaris_os_server_openFileDescriptors_Utilization
    • solaris_os_server_openFileDescriptors_UsedCount
    • solaris_os_server_loggedInUsers_Pct
    • solaris_os_server_runningProcesses_Pct
    • solaris_os_server_Semaphores_Utilization
    • solaris_os_server_messageQueueIDs_Utilization
    • solaris_os_server_sharedMemoryIDs_Utilization
  • Provided the user should have a tmp folder, which the application uses to store cache data while running script.
  • For users to apply log file monitoring, they must have a home directory on the system on which the script will be run.
pwd

[content@centos-node1 ~]$ pwd
/home/content
  • Non-root users should have a home directory and make sure the user has read, write & execute permissions to that directory for log file monitoring.
    (As part of log file monitoring, the application will copy the .sh script file into the Solaris device which is responsible for log file monitoring. This will copy the file into user’s home directory)

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
Solaris Serversolaris_os_server_logFile_AlertStatisticsSolaris OS Server Log file alert Statistics1.0.0Solaris OS Server log file monitoring alert statistics
solaris_os_server_openFileDescriptors_UtilizationSolaris OS Server open file descriptor utilization%1.0.0Solaris Open File Descriptors Used Percentage
solaris_os_server_openFileDescriptors_UsedCountSolaris OS Server open file descriptor used countCount1.0.0Current number of Open File Descriptors
solaris_os_server_loggedInUsers_PctSolaris OS Server logged in users percentage%1.0.0Current number of logged in users percentage
solaris_os_server_loggedInUsers_CountSolaris OS Server logged in users count
Count1.0.0Current number of logged in users
solaris_os_server_runningProcesses_PctSolaris OS Server running processes percentage
%1.0.0Current running processes percentage
solaris_os_server_runningProcesses_CountSolaris OS Server running processes countCount1.0.0Current number of running processes
solaris_os_server_semaphores_UtilizationSolaris OS Server semaphores utilization%1.0.0Semaphore ID's used percentage
solaris_os_server_semaphores_UsedCountSolaris OS Server semaphores used countCount1.0.0Current number of semaphore ID’s in use
solaris_os_server_messageQueueIDs_UtilizationSolaris OS Server message queue IDs utilization%1.0.0Used percentage of current message queue ID's
solaris_os_server_messageQueueIDs_UsedCountSolaris OS Server message queue IDs used countCount1.0.0Current number of message queue ID’s in use
solaris_os_server_sharedMemoryIDs_UtilizationSolaris OS Server shared memory IDs utilization%1.0.0Used percentage of shared memory ID's
solaris_os_server_sharedMemoryIDs_UsedCountSolaris OS Server shared memory IDs used countCount1.0.0Current number of shared memory ID’s in use
solaris_os_server_cpu_total_UtilizationSolaris OS Server CPU utilization%1.0.0System CPU Utilization
solaris_os_server_cpu_logicalProcessor_UtilizationSolaris OS Server CPU logical processor utilization%1.0.0System CPU logical processor Utilization
solaris_os_server_cpu_LoadSolaris OS Server CPU load1.0.0Average cpu load for 1 min, 5 min and 15 min
solaris_os_server_realMemory_ScanRateSolaris OS Server real memory scan ratepsec1.0.0Memory scan rate in pages per second.
solaris_os_server_realMemory_pageOuts_PagesPerSecSolaris OS Server real memory page outs pages per secpsec1.0.0Memory page out rate in pages per second.
solaris_os_server_realMemory_pageOuts_KiloBytesPerSecSolaris OS Server real memory page outs kilobytes per secKBps1.0.0Memory pages page out rate in KiloBytes per second.
solaris_os_server_memory_UsedInMBSolaris OS Server memory usedMB1.0.0System Memory Used Space
solaris_os_server_memory_UtilizationSolaris OS Server memory utilization%1.0.0System Memory Utilization
solaris_os_server_swapMemory_UsedInKBSolaris OS Server swap memory usedKB1.0.0Swap memory used
solaris_os_server_swapMemory_UtilizationSolaris OS Server swap memory utilization%1.0.0Swap memory utilization in percent.
solaris_os_server_individual_swapArea_UtilizationSolaris OS Server individual swap area utilization%1.0.0Individual swap area utilization in percent.
solaris_os_server_fileSystem_space_UtilizationSolaris OS Server file system space utilization%1.0.0File system space utilization in percent
solaris_os_server_fileSystem_space_UsedInMBSolaris OS Server file system space used in MBMB1.0.0File system space usage in MB
solaris_os_server_fileSystem_space_DeltaInKBSolaris OS Server file system space delta in KBKB1.0.0File system space usage(KB) delta
solaris_os_server_fileSystem_Inodes_UtilizationSolaris OS Server file system Inodes utilization%1.0.0File system Inodes utilization percent.
solaris_os_server_fileSystem_Inodes_Usage_NumberSolaris OS Server file system Inodes usage numberCount1.0.0File system Inodes usage number.
solaris_os_server_fileSystem_Inodes_DeltaSolaris OS Server file system Inodes deltaCount1.0.0File system Inodes usage delta.
solaris_os_server_fileSystem_mount_ChangeDetectionSolaris OS Server file system mount change detection1.0.0File system mount point change detection. It detects if any file system mount point is removed and if any new mount point added into the system. Below are the possible values: 0 - Available, 1 - Newly Added, 2 - Removed
solaris_os_server_mountpoint_space_UtilizationSolaris OS Server mount point space utilization%1.0.0Mount point space utilization in percent
solaris_os_server_mountpoint_space_UsedInMBSolaris OS Server mount point space used in MBMB1.0.0Mount point usage in MB
solaris_os_server_mountpoint_space_DeltaInKBSolaris OS Server mount point space delta in KBKB1.0.0Mount point space usage(KB) delta
solaris_os_server_mountpoint_Inodes_UtilizationSolaris OS Server mount point Inodes utilization%1.0.0Mount point Inodes utilization percent.
solaris_os_server_mountpoint_Inodes_Usage_NumberSolaris OS Server mount point Inodes usage numberCount1.0.0Mount point Inodes usage number.
solaris_os_server_mountpoint_Inodes_DeltaSolaris OS Server mount point Inodes deltaCount1.0.0Mount point Inodes usage delta.
solaris_os_server_mountpoint_availability_StatusSolaris OS Server mount point availability status1.0.0Availability status of mount point. These are possible values : 0 - Not Available 1 - Available
solaris_os_server_network_interface_OutTrafficSolaris OS Server Network Out TrafficKbps1.0.0Monitors Out traffic of each interface for solaris Devices.
solaris_os_server_network_interface_OutPacketsSolaris OS Server Network out packetspackets/sec1.0.0Monitors Out packets of each interface for solaris Devices
solaris_os_server_network_interface_OutErrorsSolaris OS Server Network Out ErrorsCount1.0.0Monitors network out errors of each interface for solaris Devices
solaris_os_server_network_interface_InPacketsSolaris OS Server Network In packetspackets/sec1.0.0Monitors in Packets of each interface for solaris Devices
solaris_os_server_network_interface_InErrorsSolaris OS Server Network In ErrorsCount1.0.0Monitors network in errors of each interface for solaris Devices
solaris_os_server_network_interface_CollisionsSolaris OS Server Network Interface collisionsCount1.0.0Monitors network collisions of each interface for solaris Devices
solaris_os_server_network_interface_InTrafficSolaris OS Server Network In TrafficKbps1.0.0Monitors In traffic of each interface for solaris Devices
solaris_os_server_process_RunningStatusSolaris OS Server process running status1.0.0Monitors status of each user mentioned process. possible values 0-Not Running, 1- Running
solaris_os_server_zfs_zpool_UsedInGBSolaris OS Server ZFS zpool UsedGB1.0.0Provides Solaris OS Server ZFS zpool Used in MB
solaris_os_server_zfs_zpool_UtilizationSolaris OS Server ZFS zpool utilization%1.0.0Provides Solaris OS Server ZFS zpool utilization in percent
solaris_os_server_zfs_zpool_HealthSolaris OS Server ZFS zpool Health1.0.0Solaris OS Server ZFS zpool Health status. possible values 0-DEGRADED, 1-ONLINE, 2-SUSPENDED, 3-UNAVAIL, 4-,UNKNOWN 5-CLEARED
solaris_os_server_zone_StatusSolaris OS Server zone status1.0.0Solaris OS Server zone status. possible values 0-RUNNING, 1-CONFIGURED, 2-INSTALLED, 3-READY, 4-HALTED, 5-INCOMPLETE

Default Monitoring Configurations

Solaris OS Server 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 app to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for each Native Type of Solaris OS Server. 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: solaris-os-server Solaris Server - 1 (i.e, appName = solaris-os-server, nativeType = Solaris Server, version = 1)

  2. Default Global Templates

    OpsRamp has a Global template for each Native Type of Solaris OS Server. 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: solaris-os-server Solaris Server Template - 1 (i.e, appName = solaris-os-server, nativeType = Solaris Server, version = 1)

  3. Default Global Monitors

    OpsRamp has a Global Monitors for each 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: Solaris Server Monitor solaris-os-server Solaris Server - 1(i.e, monitorKey = Solaris Server Monitor, appName = solaris-os-server, nativeType = Solaris Server, version = 1)

Configure and Install the Solaris OS Server Integration

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed.
    Note: If there are no installed applications, it will navigate to the Available Integrations and Apps page.
  5. 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.
Fujitsu Eternus
  1. Click ADD in the Solaris OS Server 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.
IP Address/Host NameIP address/host name of the Solaris OS Server.
PortPort

Note: By default 22 is selected.
CredentialsSelect the Credential from the drop-down list.

(Optional) 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.
Additional ConfigurationsEnter the additional configuration.

Note: By default {"File Systems":"ufs,vxfs,zfs,iofs,nfs","Mount Points":"/tmp,/var/crash","Processes":"syslogd,cron,init,sshd,sendmail,event_logger,had,vxconfigd,fsflush"} is added.

Notes:

  • 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.
    • Log File Monitoring: configure the values for below fields as per your log file monitoring use case:
      • Log File Configuration: [{“Name”:"",“File Name”:"",“Rotated File Name”:"",“Expression”:"",“Check Type”:"",“Threshold”:"",“Severity”:""}].
  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.
Fujitsu Eternus

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

  1. 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.

  2. Click NEXT.

  3. (Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

Veeam
  1. Select an existing registered profile.
Veeam
  1. Click FINISH.

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

Modify the Configuration

View the Solaris OS Server Details

To discover resources for Solaris OS Server:

  1. Navigate to Infrastructure > Search > OS > Solaris OS Server.
  2. The SOLARIS OS SERVER page is displayed, select the application name.
  3. The RESOURCE DETAILS page appears from the right.
  4. Click the ellipsis () on the top right and select View details.
  5. Navigate to the Attributes tab to view the discovery details.
Fujitsu Eternus
  • Click the Metrics tab to view the metric details for Solaris Server.

View resource metrics

To confirm Solaris OS Server 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.
Fujitsu Eternus

Resource Filter Input Keys

Solaris OS Server application Resources are filtered and discovered based on below keys:

Note: You can filter the resources with the discoverable keys only.

Click here to view the Supported Input Keys
Resource TypeSupported Input Keys
All TypesresourceName
hostName
aliasName
dnsName
ipAddress
macAddress
os
make
model
serialNumber
Kernel architecture
Application architecture
Hardware provider
Host ID
Computer architecture
Installed Memory
Processor Type
Physical Processor(cpu) count

Supported Alert Custom Macros

Customise the alert subject and description with below macros then it will generate alerts based on customisation.

Click here to view the alert subject and description with macros

                                ${resource.name}

                                ${resource.ip}

                                ${resource.mac}

                                ${resource.aliasname}

                                ${resource.os}

                                ${resource.type}

                                ${resource.dnsname}

                                ${resource.alternateip}

                                ${resource.make}

                                ${resource.model}

                                ${resource.serialnumber}

                                ${resource.systemId}

                                ${Custome Attributes in the resource}

                                ${parent.resource.name}

Risks, limitations & assumptions

  • Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration
    • Connectivity Exception
    • Authentication Exception
  • Application uses the provided IPAddress/hostname, credentials for SSH communications.
  • Application will send duplicate/repeat failure alert notification for every 6 hours.
  • Application cannot control monitoring pause/resume actions based on above alerts.
  • Metrics can be used to monitor Solaris Server resources and can generate alerts based on the threshold values.
  • OpsRamp has provided 22 as default SSH Port value for connecting to Solaris end device via SSH. Users can modify this value from the application configuration page at any point of time if required.
  • No support of showing activity log and applied time.
  • Full discovery support requires gateway version 15.0.0 or above.
  • This application supports both Classic Gateway and NextGen Gateway.
  • Currently we do not have monitoring support for below:
    • Hardware metrics
    • Processes (We provided one metric for each process RunningStatus. i.e, solaris_os_server_process_RunningStatus)
  • Use the below commands to fetch max limits, see To configure shared memory and semaphores on Solaris for more information.
Max Limit Commands

Semaphore ID Limit: echo seminfo_semmni/D | mdb -k

Shared memory ID Limit: echo shminfo_shmmni/D | mdb -k

Message Queue ID Limit: echo msginfo_msgmni/D | mdb -k
  • Need below json payload as input for log monitoring:
    • Name: This can be any string used to identify individual log configuration.
    • File Name: It is a combination of folder path and file name. Folder path should contain the exact path for the file as prefix. File name can be any valid string or regular expression. In case of file not found with specified file name, alert will be generated with the severity specified by the user.
      Example 1: C:\Program Files (x86)\Vistara\Agent\log\Age.?t.log
      Matches: Agent.log, Ageat.log ,..
    • Rotated File Name: It is similar to file name field but specifying the rotated file. This is a optional field.
    • Expression: This can be any valid string or regular expression used to specify the search string. It is a mandatory field.
    • Check Type: This can be either “exists” or “not exists”(case insensitive).
    • Threshold: This can be any valid integer. Alert will be generated in case of specified threshold breach happens.
    • Severity: It is used to specify the alert type to be created in case of expression found. Possible values are CRITICAL, WARNING, INFO, and OK (case insensitive).

Log file configuration:

 [
  {
  "Name":"",
  "File Name":"",
  "Rotated File Name":"",
  "Expression":"",
  "Check Type":"",
  "Threshold":"",
  "Severity":""
  }
]

  • We do not process logs of size greater than 1GB.
  • We do not process logs for the first request, since it leads to performance issues due to huge data.
  • We consider the latest logs ( logs generated between first and second polls) from the second request and process accordingly.
  • No recovery alerts are generated for expression related alerts. we will get recovery only for file not found alerts.