61
LAST UPDATED: 06/23/2020 INFINIMETRICS USER GUIDE

INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

  • Upload
    others

  • View
    0

  • Download
    0

Embed Size (px)

Citation preview

Page 1: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

     

LAST UPDATED: 06/23/2020

INFINIMETRICS USER GUIDE

Page 2: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

 2

Table of Contents1 InfiniMetrics Installation Instructions ______________________________________4

1.1 Introduction to InfiniMetrics ...................................................................................................... 4

1.2 Access control of InfiniMetrics.................................................................................................... 5

1.3 Installing InfiniMetrics ................................................................................................................ 6

1.4 Uninstalling InfiniMetrics............................................................................................................ 6

1.5 Upgrading InfiniMetrics .............................................................................................................. 7

1.6 Uploading and replacing the InfiniMetrics SSL certificate...................................................... 12

2 Viewing systems with InfiniMetrics 5.x ____________________________________15

2.1 Viewing the InfiniBox systems using InfiniMetrics 5.x............................................................. 15

2.2 Viewing the InfiniGuard 2.0 systems ........................................................................................ 20

2.3 How latency is monitored......................................................................................................... 23

3 The InfiniMetrics Dashboard ____________________________________________24

3.1 Determining how many entities to monitor ............................................................................ 24

3.2 Viewing systems monitored by InfiniMetrics........................................................................... 24

4 Viewing the Monitored System __________________________________________26

4.1 Annotating a chart .................................................................................................................... 26

4.2 Viewing the detailed InfiniMetrics monitors............................................................................ 28

4.3 Viewing the metrics of InfiniBox entities ................................................................................. 30

4.4 Viewing the monitored entity................................................................................................... 31

5 InfiniMetrics Auxiliary Tasks ____________________________________________34

5.1 Changing the appliance network settings via VAMI ................................................................ 34

5.2 Expanding the disk space of the InfiniMetrics appliance (v4 and earlier).............................. 36

5.3 Expanding the disk space of the InfiniMetrics appliance (v.5.0.x).......................................... 37

5.4 Exporting the metrics................................................................................................................ 39

5.5 InfiniMetrics Sizing Guide ......................................................................................................... 41

5.6 Installing InfiniMetrics v.4 and earlier on a vanilla Ubuntu server ......................................... 42

5.7 Installing InfiniMetrics v.5.0.x on a vanilla Ubuntu server ...................................................... 43

5.8 Migrating from InfiniMetrics 4.x to 5.0 ..................................................................................... 45

5.9 Migrating InfiniMetrics from 2.5.x to 2.6.x................................................................................ 49

Page 3: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

 3

5.10 Troubleshooting InfiniMetrics - Collecting logs....................................................................... 51

5.11 InfiniMetrics Call Home............................................................................................................. 52

5.12 Troubleshooting InfiniMetrics Call Home ................................................................................ 54

6 InfiniMetrics API ______________________________________________________56

6.1 Using InfiniMetrics public API................................................................................................... 56

6.2 InfiniMetrics API Fields Reference ............................................................................................ 56

Page 4: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  4

1 InfiniMetrics Installation Instructions

1.1 Introduction to InfiniMetrics

1.1.1 What is INFINIDAT InfiniMetricsINFINIDAT InfiniMetricsTM is a VMware appliance for collecting and displaying performance metrics from one or more InfiniBoxes. InfiniMetricsTM is a trademark of INFINIDAT.

1.1.2 Terminology

InfiniBox The INFINIDAT storage system that InfiniMetrics connects to.

OVF / OVA OVF (Open Virtualization Format) is an industry standard developed by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image.This format is supported, among other platforms, by VMware vCenter 4.0 and above.The OVA contains an OVF file along with other files needed for the deployment of the virtual machine.

1.1.3 Installation prerequisitesThe InfiniMetrics installation requires the following:

vSphere Version 5.x and up

vCPU 2

Memory 8GB

Disk space 30GB

Browser IE10 or higher, Firefox, Chrome

IP address for the appliance DHCP and manual configuration are supported

IP connectivity from the appliance to the InfiniBox systems

Ports 80, 443

The information above is the minimum requirements. For appliances with more than 2 monitored systems, please refer to the InfiniMetrics Sizing Guide. 

Page 5: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  5

•••

••

1.

a.

b.

c.

2.

a.

1.1.4 A note on storage requirementsThe InfiniMetrics virtual appliance requires, by default, a 30GB virtual hard disk that is suitable for storing data of up to 4 InfiniBox systems with about 50 monitored entities (hosts, volumes) each. If these limits are surpassed, more storage will be required. Along with the added storage, it is also recommended to increase the VM's CPU allocation and RAM allocation to handle the increased load.

How to increase the disk space:

InfiniMetrics Sizing GuideAdd extra capacity to InfiniMetrics versions prior to 2.2Expanding the disk space of the InfiniMetrics appliance (v4 and earlier)

1.2 Access control of InfiniMetrics

1.2.1 How to access InfiniMetricsViewing the metrics of an InfiniBox system requires credentials that are set on the InfiniBox system (local user).Do not access InfiniMetrics using credentials of an LDAP user.The local user can be set with a permission level of ReadOnly, thus, can cause no harm to the monitored InfiniBox systems.If you still prefer to access InfiniMetrics by a LDAP user, note that any LDAP connectivity issue will result in InfiniMetrics not collecting InfiniBox data.

1.2.2 Instructions on how to set a user on InfiniBox

On InfiniBox

Login to InfiniBox with an Admin user

Select Settings from the menu and then click the Users tab

Create a local user with a Read_Only user role

On InfiniMetrics

Use the user you created on step 1 to log into InfiniMetrics

For more information: see the Authentication and Security and LDAP Integration chapters on the InfiniBox user documentation.

Page 6: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  6

1.2.3.

4.

5.6.

7.8.

a.

b.

c.

d.9.

10.

1.3 Installing InfiniMetrics

1.3.1 Download site for the installation fileThe InfiniMetrics installation file is provided in an OVA format. The OVA file is available from:

 https://repo.infinidat.com/home/main-stable#infinimetrics

1.3.2 Installation instructionsThe installation of InfiniMetrics allows you to monitor one or more InfiniBox systems.

Download the installation file as explained above.Open the vCenter client and select File  > Deploy OVF Template from the menu.On the Source pane, browse to the installation file that you downloaded on Step 1 above.Click Next.Review the details on the OVF Template Details pane and click Next.

Review the Name and Location of InfiniMetrics. Click Next.Select a host, or cluster on which the template will be deployed. 

Select between thick and thin provisioning formats, all supported by Infinidat.Set the networking properties:

Default gateway - leave blank if DHCP is used

DNS - leave blank if DHCP is used

Network1 IP address - the VM IP address

Network1 Mask - leave blank if DHCP is usedReview a summary of the deployment settings and click Finish.The template is deployed.Make sure that the VM is powered on.Copy the IP address (on the Summary tab) to your browser.

1.4 Uninstalling InfiniMetricsYou may uninstall InfiniMetrics by selecting either Remove from inventory or Delete.

InfiniMetrics requires support for SSE 4.2.For ESX clusters with Enhanced vMotion Compatibility, EVC levels L2 (Intel) and B1 (AMD) or higher are required to expose the SSE4.2 CPU flags.For more information, see Enhanced vMotion Compatibility (EVC) processor support (1003212) on VMware Knowledge Base.

Page 7: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  7

1.

a.

b.

On the Inventory panel, right-click a host and select either Remove from inventory or Delete from

disk from the Host pop-up menu.

Remove from inventory - This option does not delete the virtual appliance from the disk.

Delete from disk - This option deletes the virtual appliance from the disk.

1.5 Upgrading InfiniMetrics

1.5.1 Supported upgrade paths

To:

From:

2.2.x 2.3.x 2.5.x 2.6.x 3.0.x 4.0.x 4.1.x 4.2.x 4.3.x 5.0.x 5.1.x

2.2.x

2.3.x

2.5.x See here

2.6.x

3.0.x

4.0.x

See here

4.1.x

4.2.x

4.3.x

5.0.x

5.1.x

Page 8: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  8

1.

a.b.

2.

INFINIDAT leverages VMware's native Update Manager by providing a tool that checks for upgrades. This tool is accessible via the internet.

If your vCenter Server does not have an internet connection, you can use other upgrade methods as described further down this section.

1.5.2 Download site for the installation fileThe InfiniMetrics installation file is provided in an OVA format. The OVA file is available from:https://repo.infinidat.com/home/main-stable#infinimetrics

1.5.3 Backing up the VMPrior to the upgrade, it is advised to back up the InfiniMetrics VM.

1.5.4 Upgrading InfiniMetrics via the internetThis section explains how to upgrades InfiniMetrics using the INFINIDAT Upgrade Tool.

On a browser, access INFINIDAT Upgrade Tool: https://<infinimetrics_vm>:5480Use the following credentials:

User: rootPassword: nfinidat1

The INFINIDAT Upgrade Tool opens on screen.

Click the Update tab.Your current InfiniMetrics version is displayed on the screen.

There is no direct upgrade path to version 5.0. You can migrate your data from version 4.x. For more information, see Migrating from InfiniMetrics 4.x to 5.0

Page 9: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  9

3.

4.

1.

a.

b.

Click Check Updates.Details of the available update are displayed on screen

Click Install Updates.The available update is installed. 

1.5.5 Manually providing the upgrade fileThis section explains how to upgrade InfiniMetrics when the upgrade file is provided manually.

Go to the repository site (see the link on the top of this page).

Select InfiniMetrics on the navigation tree.

Click on Other versions and platforms.

Select the file that ends with ISO and download it.

Page 10: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  10

c.

2.

a.

b.

c.

1.

2.

Mount the ISO file to the VM as a CD ROM device.

On the INFINIDAT Upgrade Tool:

Go to the INFINIDAT Upgrade Tool as explained above.

Click on Updates, then on Settings and select the CD ROM Updates option.

Upload the file and click Save.

1.5.6 Using a specified repository for upgrade filesInstall the INFINIDAT Application Repository.A link to the relevant Application Repository documentation is available on top of this page.Populate the Application Repository with the InfiniMetrics upgrade package.Point the InfiniMetrics appliance to fetch the package from the Application Repository.Copy the Repository URL and replace repo.infinidat.com with the new repo address.

Page 11: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  11

1.2.

••

 

1.5.7 Using the vm upgrade manager

Repeat step 1 of Manually providing the upgrade file (above).Go to the Upgrade Manager.For instructions on upgrading InfiniMetrics via the native VMware Update Manager, see VMware Studio 2.6 User Guide page 21.

1.5.8 Upgrading to InfiniMetrics 4.1 or newer from earlier releasesInfiniMetrics 4.1 introduces InfiniMetrics Call Home. First-time activation - the Call Home requires INFINIDAT support

Page 12: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  12

1.

a.

b.

1.6 Uploading and replacing the InfiniMetrics SSL certificate

1.6.1 About this taskAs of InfiniMetrics release 4.2, all HTTP communications will be redirected to HTTPS. InfiniMetrics uses a self-signed certificate by default.

This task allows the customer to secure the communication to InfiniMetrics using either a customer-provided, or an externally-provided  SSL certificate. 

Before you begin

InfiniMetrics makes sure that the certificate meets the following criteria.

The private key should not be password protected.The certificate part and private key part should be in PEM format:

.PEM = The PEM extension is used for different types of X.509v3 files which contain ASCII (Base64) data prefixed with a —– BEGIN … line.

If the PEM file contains more than one public certificate, then the first one on the file should be the one that matches the private key of the certificate (as this is the one that matches the InfiniMetrics server FQDN)

InfiniMetrics does not validate:

The certificate trust-chain

In case you are unable to access an unauthorized website

In case corporate policy prevents you from accessing an unauthorized website, follow the relevant instructions at the bottom of this page. 

Terminology

Certificate - A file allowing a client to validate the identity of the server it is communicating with using information from a 3rd party CAEach certificate is signed by another certificate, creating a chain up to a parent that both sides can trust. SSL-Certificate - a certificate used to verify HTTPS servers.

1.6.2 Importing a certificate to InfiniMetrics

Access InfiniMetrics release 4.2 and above.

As you do not have an SSL certificate yet, the message on the browser says that the

connection is not private.

Proceed to the InfiniMetrics GUI Your browser may require additional confirmations to

continue.

Page 13: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  13

2.

3.

••

••

Click the Action menu and then click on Certificate Settings. 

The SSL Certificate Settings screen opens.

Upload the certificate file from your computer and click Save.

InfiniMetrics validates the certificate and starts using it. The validity of the certificate is indicated

on the screen as follows:Issue date 

Red -  if the current date is earlier than issue date.InfiniMetrics calculates the exact date and time and displays only the date

Green - if the current date is same or after the issue date.

Page 14: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS INSTALLATION INSTRUCTIONS  –  14

••••

••

Valid until date Red - if the current date is after the valid until date.Yellow - if there are less than 30 days until the certificate expiration date.Green - otherwise.

1.6.3 Installing the certificate without accessing an unauthorized websiteIn case you cannot access the InfiniMetrics website can select from the following options:

Downloading the initial, self-signed, certificate and adding it to the trusted-root certificate list on your computer and then entering the website and changing the certificate.SSH into the InfiniMetrics server:

Copy the PEM file to the server using: 

scp <pem_file>.pem root @<remotehost>:/etc/ssl/private/custom-pem

The root password is nfinidat1.Verify the PEM file validity and nginx configuration:

nginx -t

SSH into the same server and reload lighttpd and nginx server, or reboot the server: 

service nginx reload

service lighttpd reload

Verify that the Infinimetrics GUI remains accessible, and check that the certificate loaded and is used by visiting the Certificate Settings.

Further configuration of certificate formats other than PEM is beyond the scope of InfiniMetrics documnetation.

Page 15: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING SYSTEMS WITH INFINIMETRICS 5.X  –  15

•••••••

2 Viewing systems with InfiniMetrics 5.x

2.1 Viewing the InfiniBox systems using InfiniMetrics 5.x

2.1.1 Monitoring InfiniBox 5.x systemsInfiniBox 5.x systems can be monitored from InfiniMetrics versions 4.3 and later.

Viewing the monitored entities

When monitoring InfiniBox 4.x systems using InfiniMetrics 5.x, there is no need to select what entities to monitor. InfiniMetrics 5.x monitors all of the InfiniBox entities that are mapped to a host (or a cluster). 

Viewing systems monitored by InfiniMetrics

InfiniMetrics main screen

The main screen of InfiniMetrics displays the monitored systems along with a summary of their key metrics. On top of the screen, the total number of monitored systems and the number of system alerts are displayed.The following information is accumulative for all of the systems: number of monitored systems, system capacity (physical allocated, physical free, virtual allocated, virtual free).

The following information is displayed for each of the systems:

System name - the name of the system and its typeInfiniBox modelSerial number - the system serial numberInfiniBox software versionPerformance - throughput and OPS for SAN and NASPhysical capacity - total and free capacityVirtual capacity - total and free capacity

Whenever InfiniMetrics cannot connect to a system, an alert is displayed on the screen.

Adding a system

To monitor your systems, simply add them to the InfiniMetrics dashboard:

Page 16: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING SYSTEMS WITH INFINIMETRICS 5.X  –  16

1.

2.

••

1.

••

1.

2.

On the InfiniMetrics dashboard, click Add System.

Provide the system URL and credentials.

The system is added to the InfiniMetrics dashboard.

2.1.2 Viewing the Monitored SystemsUpon adding a system, all of the system entities are automatically monitored as follows:

Hosts, clusters, pools, volumes and filesystems are added within 2 minutes from creationOnly mapped volumes and exported filesystems are monitored

The entities are monitored in 10 seconds intervals

Monitoring an entity

Use the menu on the left side of the InfiniMetrics screen to select an entity. For example, to view a replica:

Select Replication from the menu.

The Replication screen opens, displaying of the replicas for this InfiniBox systems. The replicas

are sorted by Replication Links.

Searching for an entity

On the entity screen (in this example, the Volumes screen), search for a volume by its nameAdditionally, you can filter the volume's list by pool

Aggregated view

Select several entities (for example, several volumes) 

Click Aggregate. 

The volumes performance indicators are displayed together 

Page 17: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING SYSTEMS WITH INFINIMETRICS 5.X  –  17

1.

2.

Annotating a chart

You can add annotations to any point-in-time to any of the graphs. The annotations can be searched for, thus enhancing the way to generate meaningful knowledge out of the raw data.InfiniMetrics automatically annotates for important system events.

Adding an annotation

Right-click any point-in-time on the graph and select Add Annotation from the pop-up menu.

The Add Annotation screen opens.

Add a description. Select where the annotation will be displayed (the default is everywhere – that

is all of the graphs of this system).

Select a marker style (the default value is green).

Page 18: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING SYSTEMS WITH INFINIMETRICS 5.X  –  18

3.

Click Save.

Viewing the annotation

Mouse-over the annotation mark on the graph. The annotation description popes-up.

Page 19: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING SYSTEMS WITH INFINIMETRICS 5.X  –  19

1.

2.

Searching for an annotation

Right-click anywhere on the graph and select Find Annotation from the pop-up menu.

The Find Annotation screen opens. 

You can either browse for an annotation – they are sorted by time stamp – or search for them.

Note that the manually inserted annotation is colored green, where system events are colored

blue.

Page 20: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING SYSTEMS WITH INFINIMETRICS 5.X  –  20

3.

••

•••••••

1.

2.

Click View to see the annotation on the graph.

2.1.3 Enhanced Latency graph for SAN entitiesWhen looking at the SAN entities graphs of an InfiniBox system, the Latency graph is renamed to Total Latency graph. This graph allows to select between two graphs:

SAN total latency by I/O typeSAN internal latency vs. total latency 

The graphs, and the way the latency is monitored are discussed here: How latency is monitored.

2.2 Viewing the InfiniGuard 2.0 systems

2.2.1 Monitoring InfiniGuard 2.0 systemsMonitoring InfiniGuard 2.0 systems can be done only with InfiniMetrics 4.2 and later.

Viewing systems monitored by InfiniMetrics

The InfiniMetrics Dashboard

The InfiniMetrics 4.2 main screen introduces two tabs: InfiniBox and InfiniGuard. Clicking any of the two tabs displays a list of monitored systems.

For InfiniGuard systems, the following information is displayed:

Name - the name of the InfiniGuard system, and a link to its GUIModel - the InfiniGuard modelSerial - serial number of the InfiniGuard systemVersion - the software version on the underlying InfiniBox systemTotal throughput - for each DDEPhysical capacity - total and free capacityData reduction - the amount of storage, before and after reduction

Whenever InfiniMetrics cannot connect to a system, an alert is displayed on the screen.

Adding a system

To monitor your systems, simply add them to the InfiniMetrics dashboard:

On the InfiniMetrics dashboard, click Add System.

Provide the system URL and credentials.

The system is added to the InfiniMetrics dashboard.

Page 21: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING SYSTEMS WITH INFINIMETRICS 5.X  –  21

••

1.

2.2.2 Viewing the Monitored SystemsUpon adding a system, all of the system entities are automatically monitored as follows:

DEDUP engines, Shares, PartitionsThe entities are monitored in 60 seconds intervals

Monitoring an entity

Use the menu on the left side of the InfiniMetrics screen to select an entity. For example, to view a Share:

Select Shares from the menu.

Page 22: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING SYSTEMS WITH INFINIMETRICS 5.X  –  22

••

1.

2.

3.

1.

The Shares screen opens.

Searching for an entity

On the entity screen (in this example, the Shares screen), search for a Share by its nameAdditionally, you can filter the Shares by their DDE

Annotating a chart

You can add annotations to any point-in-time to any of the graphs. The annotations can be searched for, thus enhancing the way to generate meaningful knowledge out of the raw data.

Adding an annotation

Right-click any point-in-time on the graph and select Add Annotation from the pop-up menu.

The Add Annotation screen opens.

Add a description. Select where the annotation will be displayed (the default is everywhere – that

is all of the graphs of this system).

Select a marker style (the default value is green).

Click Save.

Viewing the annotation

Mouse-over the annotation mark on the graph. The annotation description popes-up.

Searching for an annotation

Right-click anywhere on the graph and select Find Annotation from the pop-up menu.

The Find Annotation screen opens. 

Page 23: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING SYSTEMS WITH INFINIMETRICS 5.X  –  23

2.

3.

•••••

••

You can either browse for an annotation – they are sorted by time stamp – or search for them.

Note that the manually inserted annotation is colored green, where system events are colored

blue.

Click View to see the annotation on the graph.

2.2.3 Selecting a time frameYou can see various time frames using the following options:

Select a preset time frame from the menuSelect a range of datesUsing a mouse click, select a portion of the graph time-axis to see only this time frameDouble-click to return to the previous time frame selectionUse the SHIFT key to scroll through the time axis (either right or left) without changing the resolution 

2.3 How latency is monitored

DefinitionsInfiniBox measures the latency associated with write and read requests as follows:

Total latency This is the total time the I/O operation takes, from the time of arrival of the first SCSI command (CDB) to the InfiniBox to the time the final response sent to the host. The total latency may increase due to host or fabric delays, QoS-added latency and internal latency.Internal latency This is the time InfiniBox spends handling the I/O operation, i.e. the time the I/O operation would take if there is no latency on the network, hosts are immediately responsive and no QoS is applied. Internal latency is affected by system resource use, and can increase due to synchronous replication, but is neither affected by host and fabric delays nor by QoS added latency,

2.3.1 What is monitored by InfiniMetricsAs of InfiniMetrics 4.2, we present graphs for both local total latency and local internal latency:

SAN total latency by I/O type - the total time the I/O operation takes, broken down by I/O operationsSAN internal latency vs. total latency  - the difference between internal and local latency only for volumes that are not synchronously replicated

Page 24: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

THE INFINIMETRICS DASHBOARD  –  24

••

••

•••••

3 The InfiniMetrics Dashboard

3.1 Determining how many entities to monitor

3.1.1 About this taskThe number of entities that InfiniMetrics can monitor is limited, thus to prevent excessive API requests to the monitored systems. 

3.1.2 Hard limit for the number of monitored filesystemsInfiniMetrics enforced a non-configurable limit of 100 filesystems per monitored InfiniBox system

3.1.3 Limits for the number of monitored volumes and hostsThe number of monitored volumes and hosts per InfiniBox system is configurable.

3.2 Viewing systems monitored by InfiniMetrics

3.2.1 InfiniMetrics main screenThe main screen of InfiniMetrics displays the monitored systems along with a summary of their key metrics. On top of the screen, the total number of monitored systems and the number of system alerts are displayed.

The following information is accumulative for all of the systems:

Number of monitored systemsSystem capacity

Physical - allocated and freeVirtual - allocated and free 

The following information is displayed for each of the systems:

System name - the name of the system and its typeSerial number - the system serial numberPerformance - throughput and OPS for SAN and NASPhysical capacity - total and free capacityVirtual capacity - total and free capacity

This task is only relevant for monitoring InfiniBox 3.x systems.

Page 25: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

THE INFINIMETRICS DASHBOARD  –  25

1.

2.

Whenever InfiniMetrics cannot connect to a system, an alert is displayed on the screen.

3.2.2 Adding a systemTo monitor your systems, simply add them to the InfiniMetrics dashboard:

On the InfiniMetrics dashboard, click Add System.

Provide the system URL and credentials.

The system is added to the InfiniMetrics dashboard. 

Page 26: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING THE MONITORED SYSTEM  –  26

1.

2.

4 Viewing the Monitored System

4.1 Annotating a chartYou can add annotations to any point-in-time to any of the graphs. The annotations can be searched for, thus enhancing the way to generate meaningful knowledge out of the raw data.

InfiniMetrics automatically annotates for important system events.

4.1.1 Adding an annotation

Right-click any point-in-time on the graph and select Add Annotation from the pop-up menu.

 

The Add Annotation screen opens.

Add a description. Select where the annotation will be displayed (the default is everywhere – that

is all of the graphs of this system). 

Select a marker style (the default value is green).

Page 27: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING THE MONITORED SYSTEM  –  27

1.

Click Save.

4.1.2 Viewing the annotation

Mouse-over the annotation mark on the graph. The annotation description will pop.

 

Page 28: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING THE MONITORED SYSTEM  –  28

1.

2.

3.

••

4.1.3 Searching for an annotation

Right-click anywhere on the graph and select Find Annotation from the pop-up menu.

The Find Annotation screen opens. 

You can either browse for an annotation – they are sorted by time stamp – or search for them.

Note that the manually inserted annotation is colored green, where system events are colored

blue.

 Click View to see the annotation on the graph.

4.2 Viewing the detailed InfiniMetrics monitors

4.2.1 ApplicabilityThis article discusses pre-4.x InfiniBox systems and pre-4.2 InfiniMetrics.For InfiniMetrics 5.x, see: Viewing the InfiniBox systems using InfiniMetrics 5.x

4.2.2 Viewing the system monitorsClick a system to see its various monitors.

Note - You may be asked to enter your credentials again.

Page 29: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING THE MONITORED SYSTEM  –  29

••••

1.

4.2.3 Operating the monitored systemThe following operations are available for the system view. All operation are accessible from the actions menu at the top-right of the screen:

View the system on the GUI (also available from InfiniMetrics main screen) View in API Browser (also available from InfiniMetrics main screen)Update credentials - provide InfiniShell with the credentials that are required in order to log into the systemRemove system - remove the system from InfiniMetrics

Viewing the GUI of the monitored system

You can easily navigate from the InfiniMetrics dashboard to the system's GUI (and InfiniShell):

On the InfiniMetrics dashboard, hover over the system. From the cogwheel menu, select View in

System GUI.

The system's GUI opens on a new tab (depends on your browser's settings).

Viewing the system on an API browser

You can send RESTful API requests directly from InfiniMetrics.

Page 30: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING THE MONITORED SYSTEM  –  30

1. On the InfiniMetrics dashboard, hover over the system. From the cogwheel menu, select View in

API Browser.

The API Browser opens on a new tab (depends on your browser's settings). 

4.3 Viewing the metrics of InfiniBox entities

4.3.1 Accessing the monitored entitiesThe monitors are categorized and grouped into tabs. Click a tab to see the monitors that are grouped under this topic. 

4.3.2 Monitoring a new entitySome entities are automatically listed on InfiniMetrics. For example, all of the InfiniBox pools are listed under the Pools tab.  Other entities have to be added to InfiniMetrics in order to be monitored. For example, in order to monitor a volume:

Page 31: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING THE MONITORED SYSTEM  –  31

1.

2.•

3.

4.

5.

••

••

Click the Volumes tab.

Click Add Volumes.Note: only mapped volumes can be added

Select a polling interval.

Browse for an entity, or search for it, and click it in order to move it to select it for monitoring.

Click Save. 

The selected monitors are added to the screen.

4.3.3 Viewing the monitored entitiesTo view a single entity:

Click the entityTo view several entities

Select entities and click on the Aggregate button

 

4.4 Viewing the monitored entityClick any of the monitored entities in order to view its metrics.

4.4.1 Viewing the system totalsThe system totals monitor displays the following monitors:

Page 32: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING THE MONITORED SYSTEM  –  32

•••••••••

•••

SAN IOPSSAN ThroughputSAN Total Latency by I/O Type (ms)SAN Internal vs. Total Latency (ms)SAN Average Block SizeNAS IOPSNAS Throughput NAS LatencyNAS Average Block Size

You can also focus on specific monitor types by selecting them from the display list.

4.4.2 Selecting the display rangeYou can select a display range between 1 hour and 1 year (out of a list of preset time intervals), or a customized range.

4.4.3 Selecting a timeline portion to displayYou can click and drag your mouse to select a point-in-time to display monitored data on. The range of the data that will be displayed depends on your Display Range selection (see above). 

On the monitor, click and crag your mouse over the range that you want to display.The smallest range that you can select is 30 seconds.Right-click on the monitor ans select Zoom out to return to the present timestamp.

4.4.4 Selecting which metrics to displayOut of the available monitors, you can select which to display (selecting fewer monitors increases the screen space available for the monitor).

Page 33: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

VIEWING THE MONITORED SYSTEM  –  33

1.

2.

Right click on the monitor to select whether to show annotations.

Use the monitors and SAN/NAS drop-down lists to select monitors.

4.4.5 Granularity of the sampled dataInfiniMetrics samples data at a rate of up to every 10 seconds. This level of detail is kept for one year.

Page 34: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  34

1.

2.••

3.

4.

5 InfiniMetrics Auxiliary Tasks

5.1 Changing the appliance network settings via VAMI

5.1.1 About this taskInfiniMetrics network settings (Hostname, IP, netmask, default gateway, DNS servers) are configured during initial deployment. If changes to these settings are required, use the instruction described below.

5.1.2 Instructions Use the following instructions to change the InfiniMetrics network settings.

Login to InfinimMetrics VAMI interface by pointing a web browser to InfiniMerics IP/Hostname

port 5480 using HTTPS:  

https://<infinimetrics_server>:5480 

On the Login page, enter the credentials and click Login: User: rootPassword: nfinidat1

Select the Network tab and click the Address button

Edit the settings and click the Save Settings button

Note: In case that the settings change do not persist across a reboot:

Page 35: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  35

••••••

If the network settings are set at the virtual appliance level, these settings will take precedence and will be restored on the next reboot.In order to change the network settings on the virtual appliance level, please use the following instructions:

Login to your VMware vCenter server web client Select the InfiniMetrics VM from the list of virtual machinesRight-click the VM and select Edit Settings from the menuClick the vApp Options tab and expand the Networking Properties sectionChange the settings and click the OK button

If the settings are greyed-out (uneditable), the appliance needs to be shut-down prior to changing them.

Page 36: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  36

••

1.

2.3.

5.2 Expanding the disk space of the InfiniMetrics appliance (v4 and earlier)

5.2.1 About this taskInfiniMetrics is installed with a disk space of 30GB. As Infinimetrics gathers more InfiniBox data and the amount of stored data accumulates, there may be a need for more disk space. 

Past InfiniMetrics versions

Earlier versions of InfiniMetrics are no longer supported. Please upgrade InfiniMetrics to the latest release.

5.2.2 PrerequisitesAn up and running Infinimetrics applianceAccess rights to the virtual machine that hosts Infinimetrics

5.2.3 InstructionsOn the console, stop services running on the virtual machine:

service cron stop

manage infinimetrics_services stop

service postgresql stop

service clickhouse-server stop

On the vCenter, expand the disk space of the InfiniMetrics virtual machine.On the console, run the following command: 

root@localhost:~# infinimetrics expand-disk

The command's output is: 

Page 37: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  37

4.

••

1.2.

INFO: 2015-11-12 14:11:47,439 - found device holding postgres database: /dev/

sda6

INFO: 2015-11-12 14:11:47,485 - found extended partition /dev/sda2, going to

resize it first

INFO: 2015-11-12 14:11:48,208 - device /dev/sda2 was resized.

INFO: 2015-11-12 14:11:49,905 - device /dev/sda6 was resized.

INFO: 2015-11-12 14:11:50,006 - Resizing FS.

INFO: 2015-11-12 14:11:50,006 - This might take a while ( depends on disk new

size )

INFO: 2015-11-12 14:11:50,006 - Please don't exit/break

INFO: 2015-11-12 14:11:56,916 - SUCCESS

Start the services that were previously stopped:

service clickhouse-server start

service postgresql start

manage infinimetrics_services start

service cron start

5.2.4 Related tasksConnecting to the virtual machine console - see the InfiniMetrics user guide

5.3 Expanding the disk space of the InfiniMetrics appliance (v.5.0.x)

5.3.1 About this taskInfiniMetrics is installed with a disk space of 30GB. As InfiniMetrics gathers more InfiniBox/InfiniGuard data and the amount of stored data accumulates, there may be a need for more disk space. 

Past InfiniMetrics versions

For v4.x see: Expanding the disk space of the InfiniMetrics appliance (v4 and earlier)

5.3.2 PrerequisitesAn up and running InfiniMetrics applianceAccess rights to the virtual machine that hosts InfiniMetrics

5.3.3 Instructions

On the vCenter, expand the disk space of the InfiniMetrics virtual machine.On the console, run the following command: 

Page 38: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  38

root@localhost:~# infinimetrics expand-disk

The command's output (example with two systems) is: 

Stopping service infinimetrics_1242

Stopping service infinimetrics_2271

2019-10-23 11:54:12,041 INFO root b'\xe2\x97\x8f postgresql.service -

PostgreSQL RDBMS\n Loaded: loaded (/lib/systemd/system/postgresql.service;

enabled; vendor preset: enabled)\n Active: active (exited) since Wed

2019-10-23 11:52:49 UTC; 1min 22s ago\n Process: 1043 ExecStart=/bin/true

(code=exited, status=0/SUCCESS)\n Main PID: 1043 (code=exited, status=0/

SUCCESS)\n\nOct 23 11:52:49 rbelio-post294 systemd[1]: Starting PostgreSQL

RDBMS...\nOct 23 11:52:49 rbelio-post294 systemd[1]: Started PostgreSQL RDBMS.

\n'

INFO: 2019-10-23 11:54:13,907 - rescaning disks

2019-10-23 11:54:13,907 INFO infinimetrics.scripts.expand_disk rescaning disks

INFO: 2019-10-23 11:54:15,415 - found device holding clickhouse database: /dev/

sda6

2019-10-23 11:54:15,415 INFO infinimetrics.scripts.expand_disk found device

holding clickhouse database: /dev/sda6

INFO: 2019-10-23 11:54:15,448 - found extended partition /dev/sda2, going to

resize it first

2019-10-23 11:54:15,448 INFO infinimetrics.scripts.expand_disk found extended

partition /dev/sda2, going to resize it first

INFO: 2019-10-23 11:54:15,798 - device /dev/sda2 was resized.

2019-10-23 11:54:15,798 INFO infinimetrics.scripts.expand_disk device /dev/sda2

was resized.

INFO: 2019-10-23 11:54:16,319 - device /dev/sda6 was resized.

2019-10-23 11:54:16,319 INFO infinimetrics.scripts.expand_disk device /dev/sda6

was resized.

INFO: 2019-10-23 11:54:16,320 - Resizing FS.

2019-10-23 11:54:16,320 INFO infinimetrics.scripts.expand_disk Resizing FS.

INFO: 2019-10-23 11:54:16,320 - This might take a while ( depends on disk new

size )

2019-10-23 11:54:16,320 INFO infinimetrics.scripts.expand_disk This might take

a while ( depends on disk new size )

INFO: 2019-10-23 11:54:16,321 - Please don't exit/break

2019-10-23 11:54:16,321 INFO infinimetrics.scripts.expand_disk Please don't

exit/break

2019-10-23 11:54:17,145 INFO root b'\xe2\x97\x8f postgresql.service -

PostgreSQL RDBMS\n Loaded: loaded (/lib/systemd/system/postgresql.service;

enabled; vendor preset: enabled)\n Active: active (exited) since Wed

2019-10-23 11:52:49 UTC; 1min 27s ago\n Process: 1043 ExecStart=/bin/true

(code=exited, status=0/SUCCESS)\n Main PID: 1043 (code=exited, status=0/

SUCCESS)\n\nOct 23 11:52:49 rbelio-post294 systemd[1]: Starting PostgreSQL

RDBMS...\nOct 23 11:52:49 rbelio-post294 systemd[1]: Started PostgreSQL RDBMS.

\n'

Starting service for ibox1242 (1242)

OK

Starting service for ibox2271 (2271)

OK

2019-10-23 11:54:19,772 INFO heartbeat Heartbeat command is starting...

Page 39: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  39

1.

2.

3.

2019-10-23 11:54:19,775 INFO root Collecting common data

2019-10-23 11:54:19,916 INFO heartbeat ============ System 1242 (ibox1242)

===========

2019-10-23 11:54:19,924 INFO root Collecting System totals

2019-10-23 11:54:19,964 INFO root Collecting NAS totals

2019-10-23 11:54:19,977 INFO root Collecting IO by size

2019-10-23 11:54:20,007 INFO root Collecting Read performance

2019-10-23 11:54:20,025 INFO root Collecting NAS IO by size

2019-10-23 11:54:20,099 INFO heartbeat ============ System 2271 (ibox2271)

===========

2019-10-23 11:54:20,106 INFO root Collecting System totals

2019-10-23 11:54:20,137 INFO root Collecting NAS totals

2019-10-23 11:54:20,156 INFO root Collecting IO by size

2019-10-23 11:54:20,184 INFO root Collecting Read performance

2019-10-23 11:54:20,195 INFO root Collecting NAS IO by size

2019-10-23 11:54:20,267 INFO heartbeat Heartbeat command finished

INFO: 2019-10-23 11:54:20,267 - SUCCESS

2019-10-23 11:54:20,267 INFO infinimetrics.scripts.expand_disk SUCCESS

5.3.4 Related tasksConnecting to the virtual machine console - see the InfiniMetrics user guide

5.4 Exporting the metricsYou can export any of the metrics to CSV and XLSX formats.

Login to InfiniMetrics.

Select the date range that will be exported.

Click the cog to open pop up menu on the top right corner, select Export SAN Data or Export

NAS Data based on your requirement.

Page 40: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  40

4.

5.

6.

a.

Then the Export Options screen opens.

Select the downsampling and the file format.

Click Export.

The download location depends on your browser. 

If you want to export data for a specific volume, filesystem, host, or cluster: 

Go to the volume/filesystem/host/cluster page, click the pop-up menu on the top right

corner, and select Export Data. 

Page 41: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  41

b.

••

Repeat step 4-5 for each volume, filesystem, host, or cluster.

5.5 InfiniMetrics Sizing Guide

5.5.1 OverviewThe InfiniMetrics appliance is configured by default to perform under the following load:

Monitoring 4 InfiniBox or InfiniGuard systemsSupport for 3 simultaneous web clients

When monitoring a larger number of systems, it may become necessary to increase the appliance system resources. Since resource usage is highly dependent on the level of activity of the monitored systems, it is recommended to modify the status of disk space, RAM and CPU as necessary.

Disk space

InfiniMetrics typically uses around 6 GB of disk space per monitored system for a full year of data. By default, the appliance is configured to use 30 GB, which is enough for monitoring 4 systems (plus the space used by the operating system and software).

RAM

The InfiniMetrics appliance starts with 8GB of memory. Adding more RAM may become necessary when monitoring more than a dozen systems or so.

CPU

When monitoring more than about 20 systems, the number of processes in the appliance warrants additional CPUs beyond the default two.

5.5.2 Typical configurationsThe table below shows recommended system resources based on the number of monitored systems. Your appliance may need less or more resources, depending on the systems' activity level.

Monitored systems Disk space RAM CPUs

4 30 GB 8 GB 2

8 50 GB 8 GB 2

InfiniMetrics limits the number of monitored systems to 20, and will prevent adding any more systems when reaching this limit. In order to increase this limit, please contact INFINIDAT support for assistance.

Page 42: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  42

•••

1.2.

1.

2.

3.4.

Monitored systems Disk space RAM CPUs

15 90 GB 12 GB 4

25 150 GB 16 GB 4

35 210 GB 20 GB 6

45 270 GB 24 GB 8

5.6 Installing InfiniMetrics v.4 and earlier on a vanilla Ubuntu server

5.6.1 About this taskThe InfiniMetrics installation file is also available for Ubuntu.

5.6.2 Minimum system requirementsRequirements:

64bit Ubuntu 14.04 server2GB of RAM30GB of disk space

See InfiniMetrics Sizing Guide for more details.

5.6.3 Prerequisites

Install a 64bit Ubuntu 14.04.Install the required packages:

sudo apt-get update

sudo apt-get install -y linux-libc-dev dos2unix curl unzip

5.6.4 Installation file download

Browse the InfiniMetrics section in the repository. 

Click on "Other versions and platforms".

Copy the x64_OVF10_UPDATE_ZIP download link of the latest InfiniMetrics version.Download the installation file to your Ubuntu server using curl:

Page 43: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  43

1.

2.3.

4.

•••••

curl -O <installation-file-url>

5.6.5 Installation stepsExtract the ZIP file and install all the deb packages inside it:

unzip *OVF10_UPDATE_ZIP.zip

cd package-pool

sudo dpkg -i *deb

Download the PostInstallShellScript  (attached to this page).Run the PostInstallShellScript:

dos2unix imx-post-install-script.sh

sudo bash imx-post-install-script.sh

Reboot the server.

5.6.6 Upgrading the serverThe InfiniMetrics server can be upgraded in the usual manner, as described in "Upgrading InfiniMetrics".

Alternatively, it is possible to download the new installation file using the same steps listed above, and then to run the first of the installation steps. There is no need to re-run the PostInstallShellScript.

5.7 Installing InfiniMetrics v.5.0.x on a vanilla Ubuntu server

5.7.1 About this taskThis document describes the procedure to install InfiniMetrics on a plain Ubuntu server.

5.7.2 Minimum system requirementsRequirements:

64bit Ubuntu 18.04 serverAt least 8GB of RAMAt least 30GB of disk spaceAt least 2 CPUs or coresSupport for SSE 4.2. To verify that it is supported run the following command:

Page 44: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  44

1.2.

3.

1.

2.

3.4.

grep -q sse4_2 /proc/cpuinfo && echo "SSE 4.2 supported" || echo "SSE 4.2 not

supported"

If you are planning to monitor more than 4 systems please refer to InfiniMetrics Sizing Guide for additional guidelines.

5.7.3 Prerequisites

Install a 64bit Ubuntu 18.04 server.Install the required packages:

sudo apt-get update

sudo apt-get install -y unzip curl tmux dpkg-dev

Configure the server:

sudo timedatectl set-timezone UTC

echo 0 | sudo tee /proc/sys/vm/overcommit_memory

echo 'never' | sudo tee /sys/kernel/mm/transparent_hugepage/enabled

5.7.4 Installation file download

Browse the InfiniMetrics section in the repository. 

Click on "Other versions and platforms".

Copy the x64_OVF10_UPDATE_ZIP download link of the latest InfiniMetrics version.Download the installation file to your Ubuntu server using curl:

curl -O <installation-file-url>

5.7.5 Installation stepsExtract the ZIP file and install all the required deb packages inside it:

Page 45: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  45

••

••••

unzip -j *OVF10_UPDATE_ZIP.zip -d /var/infinimetrics-repo

cd /var/infinimetrics-repo

sudo bash -c 'dpkg-scanpackages . | gzip > ./Packages.gz'

sudo echo "deb [trusted=yes] file:/var/infinimetrics-repo/ ./" > /etc/apt/

sources.list.d/infinimetrics-repo.list

sudo apt-get update

sudo DEBIAN_FRONTEND=noninteractive apt-get install -y infinimetrics

5.7.6 Upgrading the server

To upgrade to a newer version of InfiniMetrics, first delete the infinimetrics-repo directory:

rm -rf /var/infinimetrics-repo

Then, follow the instructions under Installation file download and Installation steps listed above.

5.8 Migrating from InfiniMetrics 4.x to 5.0

InfiniMetrics 5.0 contains an update to the operating system (to Ubuntu 18.04) and other infrastructure related updates. Thus, there is no direct upgrade process. Users need to deploy a new instance of InfiniMetrics 5.0 and migrate the data from the older running instance.

This guide specifies the migration process from InfiniMetrics 4.x to InfiniMetrics 5.0 while preserving data that was collected by the existing InfiniMetrics VM.

5.8.1 PrerequisitesA vCenter login with the appropriate permissions to deploy a new virtual machine.An instance of InfiniMetrics 4.x which will be migrated to the new InfiniMetrics 5.0 instance. If you are running an older InfiniMetrics release, upgrade to the latest 4.x release (currently 4.3.1) before migrating. A new VM with InfiniMetrics 5.0 installed.SSH access to the InfiniMetrics 5.0 instance.SSH access from the new InfiniMetrics 5.0 to the InfiniMetrics 4.x instance.The disk space allocated to the 5.0 instance shall be at least of the same size as allocated to the currently running InfiniMetrics 4.x databases.

The new VM should have at least the same storage capacity, RAM, and CPU allocations as the instance running InfiniMetrics 4.x.

Page 46: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  46

1.

2.

3.

4.5.

5.8.2 Migrating

Follow the installation instructions to deploy a new InfiniMetrics 5.0 VM. 

If necessary, configure your firewall to allow HTTP/HTTPS connections from the new VM to your

InfiniBoxes.

If necessary, configure your firewall/networking to allow SSH connections from the new VM to

your old VM.Log into the new InfiniMetrics 5.0 instance via SSH as root with password nfinidat1.Run the following commands:

Migrating all systems

cd /opt/infinidat/infinimetricsinfinimetrics migrate_data <IMX4.X address>

or

Migrating specific systems

cd /opt/infinidat/infinimetricsinfinimetrics migrate_data <IMX4.X address> [<comma separated list of system serials>]

Example

cd /opt/infinidat/infinimetricsinfinimetrics migrate_data infinimetrics.lab.il.infinidat.com 1066,1242,2071

TMUX

The migrate_data command will instantiate inside a new tmux session. tmux is used to keep the command running regardless of SSH/TTY connection.When the command terminates for any reason the tmux session will remain active in order to allow the audit and review of the log and action information.To terminate the tmux session after it is done, press: CTRL+b, x (Ctrl and b button simultaneously, and then the x key).If for some reason the SSH connection is closed, re-execution of the `infinimetrics migrate_data` command will connect to the current running tmux session with the last command.

Page 47: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  47

6.

7.

8.

9.

As the script runs, the new InfiniMetrics main system list view will be populated with systems as

they are added.

Once a system is displayed. you can access it via the new VM's URL using your browser. Verify

that the new systems are working properly and collecting new data.Once the script is done and the systems are all displayed (indicating successful migration), you can power off the old VM.  

Configure InfiniMetrics Call Home on the new instance. If needed, configure the PROXY and/or

firewall rules.

After verifying that the new InfiniMetrics runs properly, power off the InfiniMetrics 4.x VM. It is

recommended to keep the VM for some time before deleting it.

5.8.3 NotesIf the disk size of the new VM is smaller than the existing one, a warning will be displayed by the migration procedure.You may choose to ignore the warning and continue the migration, or abort it and increase the disk size via vCenter.If you choose to increase the disk size then you must run the following command in the terminal once the VM is powered on again:

infinimetrics expand-disk

Restart the migration process by continuing from step 4 above.

5.8.4 Troubleshooting

1. Unsupported InfiniMetrics version

The migration procedure will abort if you try to upgrade from an InfiniMetrics version prior to v4.x.You must first upgrade your existing InfiniMetrics instance to v4.x (latest is v4.3.1), and then migrate it to v5.0 as described above.

2. Not enough space on new VM

The migration process will validate that the new instance has enough disk space to move the databases from the old instance to the new one.However the script might cause a warning to be displayed if it was launched again after it was stopped, telling you that you might not have enough space in the new instance (this is due to the process

If you see any irregularity with the new InfiniMetrics, restart InfiniMetrics 4.x and shut down the new version. Contact INFINIDAT support.

Page 48: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  48

1.

2.

calculating the size of all systems located remotely and not reducing the size of systems already migrated).If you are positive you had enough space when you first launched it, you can ignore the warning and continue with the migration.

Otherwise, consider increasing the VM disk size and running the infinimetrics expand-disk command, as mentioned above.

3. Migration procedure killed before it finished

If the migration is killed for some reason, it is possible to run it again (on the same VM or on a new one). This will not cause any data loss or data duplication.

You can stop the migration anytime, using the CTRL+C or sending it a SIGINT/SIGKILL signal. This will stop the migration and delete the system it was working on from the new VM.

You can run the migration again anytime (as specified in step 5). The migration process will continue from the last system it was working on.

4. Corrupted data

If after migration and inspection of the data you found it to be corrupted or missing historical data, you can delete the specific system and migrate it again using this command:

cd /opt/infinidat/infinimetricsinfinimetrics delete <system serial> --purge-datainfinimetrics migrate_data <IMX4.X address> --serials=<system serial>

5. Rolling back to the old VM

In the unlikely event that you will need to roll back to a InfiniMetrics 4.x VM:

Power off the new InfiniMetrics 5.0 VM.

Power on the old InfiniMetrics 4.x VM.

The command will delete all data relating to that specific system from the new VM only. That includes all data collected since the migration itself and that data might not be available from the old VM if the old VM was stopped after the migration.

Page 49: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  49

••••

1.

2.

3.4.

5.

6.

6. Migrating the PEM certificate

The migration process does not migrate the PEM certificate from the old InfiniMetrics instance.After the installation of InfiniMetrics and at any point in time, one can install his PEM certificate file by following: Uploading and replacing the InfiniMetrics SSL certificate

5.9 Migrating InfiniMetrics from 2.5.x to 2.6.x

InfiniMetrics 2.6.x VMs run on Ubuntu 14.04 64-bit, while previous versions were using Ubuntu 14.04 32-bit.Since the upgrade mechanism cannot perform this OS upgrade, use the procedure below to migrate data from the old 32bit instance to the new 64bit instance.

Data that was collected by an existing InfiniMetrics VM is preserved.

5.9.1 What you'll needA vCenter login with permissions to deploy a new virtual machine.An SSH client.InfiniMetrics NG v2.6.x, available here: v2.6.1 OVA.The IP address of the existing InfiniMetrics VM you're migrating from.

5.9.2 Step-by-step guide

Deploy the InfiniMetrics NG v2.6.x OVF and power the virtual machine on.

 The new VM should not be smaller than the old VM in terms of storage, CPU, and RAM.

If necessary, configure your firewall to allow HTTP/HTTPS connections from the new VM to your

InfiniBoxes.

SSH to the VM as root, password nfinidat1Run the following commands, providing the IP address of the old InfiniMetrics VM. 

cd /opt/infinidat/infinimetricsbin/fab -f src/infinimetrics/fabfile.py -H <IP_ADDRESS_OF_OLD_VM>

Once the migration is complete, visit the URL of the new VM using your browser, and verify that

it's working and collecting new data.

Power off the old VM.

Direct migration from v2.5.x to v3.x is not supported; Please migrate to v2.6.x and then upgrade normally to the latest version.

Page 50: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  50

5.9.3 NotesIn case the disk size of the new VM is smaller than the existing one, a warning will be emitted by the migration procedure. You may choose to continue the migration, or abort it and increase the disk size via vCenter. Then run the following command in the terminal:

infinimetrics expand-disk

Restart the migration process by continuing from step 4 above.

5.9.4 Troubleshooting

1. Unsupported InfiniMetrics version

The migration procedure will abort if you try to upgrade from an InfiniMetrics version prior to 2.5. First upgrade your existing InfiniMetrics instance to v2.5.1, and then migrate it to v2.6 as described above.

2. Migration procedure killed before it finished

If the migration is killed for some reason, it is possible to run it again (on the same VM or on a new one). This will not cause any data loss or data duplication.

Option A - start from scratch

Run the migration command again. This will delete all the data from the new VM and start the migration from scratch.

cd /opt/infinidat/infinimetricsbin/fab -f src/infinimetrics/fabfile.py -H <IP_ADDRESS_OF_OLD_VM>

Option B - migrate system by system

After an initial preparation stage, the migration procedure prints out the serial numbers of the systems that will be migrated, e.g. "Systems to be migrated: 1332, 1410, 3003".

If the procedure was terminated at this point, it is possible to migrate each system separately. This way any systems that were already migrated won't have to be migrated again.

To migrate a specific system run this command:

cd /opt/infinidat/infinimetricsbin/fab -f src/infinimetrics/fabfile.py -H <IP_ADDRESS_OF_OLD_VM> migrate:<SYSTEM_SERIAL>

After migrating all systems, make sure the web server is up by running this command:

Page 51: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  51

1.

2.

3.

4.

••

1.

2.

••

service gunicorn start

3. Rolling back to the old VM

In case you need to go back to using the old InfiniMetrics 2.5.x VM:

Power off the new VM.

Power on the old VM.

SSH to the old VM as root, password nfinidat1

Run this command: "manage infinimetrics_services start"

5.10 Troubleshooting InfiniMetrics - Collecting logsWhenever an error message is displayed on screen, and the way to workaround it can't be found on this publication, please send the log to INFINIDAT Customer Support.

5.10.1 How to fetch a log

How to fetch a log from a browser

Use either of the following URLs:

If you know the InfiniBox serial number, go to: http://<InfiniMetrics>/system/<serial>/collect_logs.If you do not have the InfiniBox serial number (in this case, all logs for all of your InfiniBox systems are collected), go to:http://<infinimetrics>/collect_logs

The log file is downloaded. 

How to fetch a log from the command-line

SSH to InfiniMetrics (follow the instructions described on: Upgrading InfiniMetrics.

Run: infinimetrics collect-logs.

5.10.2 Where to send the logsSend the log file to INFINIDAT Customer Support: [email protected] other means of communications, see: www.infinidat.com/support. 

Page 52: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  52

••

a.

b.

c.

5.11 InfiniMetrics Call Home

5.11.1 IntroductionAs of release 4.1, InfiniMetrics securely sends performance data at high resolution to INFINIDAT Support. The data is sampled at 10 seconds intervals and sent every 7-8 minutes. This enables new proactive support capabilities and further enhancing the current INFINIDAT support. The data is secured and the traffic is one-directional, see further details below.

Data flow

In order for InfiniMetrics Call Home to function properly, InfiniMetrics has to be able to send HTTPS traffic outside the customer premise.

The data flows is in one direction only. The Call Home feature does not add in any way a method to connect to InfiniMetrics nor InfiniBox. For more details, see: 20679824 TCP and UDP ports required for INFINIDAT products.

The Call Home feature supports using a proxy server. The customer may choose to send the data in either of the following ways:

Via HTTPS, without using a proxy server

Using a proxy server, where both the traffic from InfiniMetrics to the proxy server and the

traffic from the proxy server to INFINIDAT Support are in HTTPS

Using a proxy server, where the traffic from InfiniMetrics to the proxy server is in HTTP

and the traffic from the proxy server to INFINIDAT Support is in HTTPS

Page 53: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  53

1.

2.

3.•

4.•

5.

1.

2.

3.

5.11.2 Instructions

Configuring InfiniMetrics Call Home 

Access the Call Home Settings screen from the menu at the top-right corner of the InfiniMetrics

screen

Leave the Send real-time performance statistics checkbox checked

If a PROXY server is used, fill in its configuration informationSpecify the username and password only if the proxy server requires authentication

Click Test Connection to verify that the connection is configured properlyThe test is followed by a success (or failure) notification on the screen

Click Save. The screen closes and performance data is sent to INFINIDAT Support

Disabling the Call Home feature

It is not recommended to disable the Call Home feature, as it will prevent INFINIDAT from providing proactive support based on this data, and will not enable using future advanced monitoring tools.

Access the Call Home Settings screen.

Uncheck the Send real-time performance statistics checkbox

Click Save. Real-time performance data will no longer be sent

5.11.3 Supported releasesThis feature applies to:

Page 54: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  54

••

••

1.

2.

3.

4.

5.

6.

1.

2.

3.

4.

InfiniMetrics 4.1 and up.InfiniBox 

Version 4.0 already supports the Call Home featureOlder InfiniBox versions need to be configured (by INFINIDAT Support) in order to support the feature

5.12 Troubleshooting InfiniMetrics Call HomeThere are certain situations that prevent InfiniMetrics from calling home - establishing a connection between InfiniMetrics and the the Infinidat Metrics Collector (Ramen). This can be the result of several issues:

The IP is not resolving the URL for the Infinidat Metrics Collector.

When there is no proxy in use - the firewall rules are missing.

If there is a proxy in use - the proxy setting for the Call Home feature is missing.

The customer proxy does not trust the Infinidat certificate.

The InfiniMetrics file system is full.

The proxy was configured during the InfiniMetrics upgrade, but was not removed. This prevents

InfiniMetrics from reaching the InfiniBoxes at the Customer Data Center.

There are several ways that can be used to solve this issue:

Make sure that Port 443 is open from IMX to callhome-eu.ramen.infiniops.com

For more information on the ports required, refer to TCP and UDP ports required for INFINIDAT

products.

If a proxy is used, there is no need to check the ports.Make sure that the InfiniMetrics DNS is properly configured. After deployment, open a secure shell (ssh) to InfiniMetrics and run the command host callhome-eu.ramen.infiniops.comIf the DNS is properly configured, the output should be similar to the following:

root@ubuntu:~# host callhome-eu.ramen.infiniops.com

callhome-eu.ramen.infiniops.com is an alias for ramen-eu-nlb-737b8efe1ef1e23d.elb.eu-west-1.amazonaws.com.ramen-eu-nlb-737b8efe1ef1e23d.elb.eu-west-1.amazonaws.com has address 52.31.207.121ramen-eu-nlb-737b8efe1ef1e23d.elb.eu-west-1.amazonaws.com has address 52.31.162.166

If the customer site uses a proxy - make sure that it properly configured, with relevant

authentication in GUI > 3-dots corner menu > Callhome Settings (Press "Test Connection" to

verify)

If the customer site does not use a proxy - make sure that the site policy does not require proxy

configuration before connection to the internet.

Page 55: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS AUXILIARY TASKS  –  55

5.

6.

To check the Infinidat certificate on your system, check it with the curl command. If you use a proxy, the command should look similar to the following:

Imetrics:~# curl https://callhome-eu.ramen.infiniops.com --proxy https://123.123.123.123:8080 -k -v

If you do not use a proxy, the command should look similar to the following:

Imetrics:~# curl https://callhome-eu.ramen.infiniops.com -k -v

In both cases, the result should show that the certificate issuer is Amazon.

issuer: C=US; O=Amazon

Make sure that the InfiniMetrics file system is not full. ssh to InfiniMetrics and run the command df -h Watch the "/" usage:

root@infinimetrics:~# df -h /Filesystem Size Used Avail Use% Mounted on/dev/sda6 144G 104G 35G 76% /

Make sure that the Use% value is less than 100%.

If you are still unable to resolve the issue, please contact Infinidat support.

Page 56: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS API  –  56

•••••

••••

6 InfiniMetrics API

6.1 Using InfiniMetrics public API

6.1.1 RESTful APIInfiniMetrics exposes a public API that supports:

Getting information about the monitored systemsUpdating system credentialsFor each system, getting the list of monitored entitiesFor each monitored entity, getting the collected data in JSON or CSV formatGetting, creating, updating and deleting annotations

The API can be accessed at http://<infinimetrics-hostname>/api/rest/ . Visit this page via a browser to try out the API and to read its documentation.

6.1.2 Other APIs

Latest System Status

GET http://infinimetrics/system/<serial>/status/

{ "status": "OK", "service_running": true, "nas_ops": 82992.7, "nas_bytes": 274991471.7, "san_ops": 40405.2, "san_bytes": 165502850.7}

Notes:

status can be OK / AUTH_FAILED / UNAVAILABLE / UNREACHABLE / DISABLED.service_running says whether the metrics collection process is running.The response includes the SAN/NAS stats only when service_running is true and status is OK.The returned information is updated every 10 seconds.

6.2 InfiniMetrics API Fields Reference

6.2.1 OverviewInfiniMetrics provides an API for getting the raw data that is collected for each monitored entity. The complete list of monitored entities can be acquired using this API endpoint: /api/rest/systems/

Page 57: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS API  –  57

••

••

••

••

••

••••••••

<system-serial>/monitored_entities/ . The data collected for a specific monitored entity is available via /api/rest/systems/<system-serial>/monitored_entities/<entity-id>/data/ . Each type of monitored entity (e.g. host, volume, filesystem) has a different set of data fields, as specified in the following sections.

6.2.2 InfiniBox NAS Entities

NAS Totals, Filesystems, Pools

These entities have the following data fields:

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"<type>_ops - number of I/O operations per second of the given type. The type is one of read, write, metadata.<type>_bytes - throughput in bytes per second of the given type. The type is one of read, write, metadata.<type>_latency - average operation latency (in milliseconds) of the given type. The type is one of read, write, metadata.ram_cache_hit_ratio - the ratio of read operations that were served from the RAM cache (between 0 and 1)ssd_cache_hit_ratio - the ratio of read operations that were served from the SSD cache (between 0 and 1)

IO By Size

IO By Size data includes read and write statistics separated into "buckets" according to the operation's block size.

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"read_ops_<bucket> - number of I/O operations per second for read operations in the bucket's block size range.read_bytes_<bucket> - throughput in bytes per second for read operations in the bucket's block size range.read_latency_<bucket> - throughput in bytes per second for read operations in the bucket's block size range.write_ops_<bucket> - number of I/O operations per second for write operations in the bucket's block size range.write_bytes_<bucket> - throughput in bytes per second for write operations in the bucket's block size range.write_latency_<bucket> - throughput in bytes per second for write operations in the bucket's block size range.

The block size ranges (buckets) are:

lt_512b - less than 512 bytesge_512b_lt_1k - 512 bytes to under 1KiBge_1k_lt_2k - 1KiB to under 2KiBge_2k_lt_4k - 2KiB to under 4KiBge_4k_lt_8k - 4KiB to under 8KiBge_8k_lt_16k - 8KiB to under 16KiBge_16k_lt_32k - 16KiB to under 32KiBge_32k_lt_64k - 32KiB to under 64KiB

Page 58: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS API  –  58

••

••

••

••

••

ge_64k_lt_128k - 64KiB to under 128KiBge_128k - 128KiB and larger

6.2.3 InfiniBox SAN Entities

Hosts, Clusters

These entities have the following data fields:

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"<type>_ops - number of I/O operations per second of the given type. The type is one of read, write, writesame, xcopy.<type>_bytes - throughput in bytes per second of the given type. The type is one of read, write, writesame, xcopy.<type>_latency - average operation latency (in milliseconds) of the given type. The type is one of read, write, writesame, xcopy.ram_cache_hit_ratio - the ratio of read operations that were served from the RAM cache (between 0 and 1)ssd_cache_hit_ratio - the ratio of read operations that were served from the SSD cache (between 0 and 1)

SAN Totals

The SAN system totals includes all fields that hosts have, with the addition of the unmap operation type. Meaning it has 3 additional fields: unmap_ops, unmap_bytes and unmap_latency.

Volumes, Pools

Volumes and pools include all fields that hosts have, with the addtion of:

max_ops - the maximum number of operations per second according to this entity's QoS policy, or null if no policy is assigned.max_bps - the maximum number of bytes per second according to this entity's QoS policy, or null if no policy is assigned.

IO By Size

IO By Size data includes read and write statistics separated into "buckets" according to the operation's block size.

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"read_ops_<bucket> - number of I/O operations per second for read operations in the bucket's block size range.read_bytes_<bucket> - throughput in bytes per second for read operations in the bucket's block size range.read_latency_<bucket> - throughput in bytes per second for read operations in the bucket's block size range.write_ops_<bucket> - number of I/O operations per second for write operations in the bucket's block size range.write_bytes_<bucket> - throughput in bytes per second for write operations in the bucket's block size range.

Page 59: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS API  –  59

••••••

••••••••••••

••

•••••••

write_latency_<bucket> - throughput in bytes per second for write operations in the bucket's block size range.

The block size ranges (buckets) are:

lt_4k - less than 4KiBge_4k_lt_8k - 4KiB to under 8KiBge_8k_lt_32k - 8KiB to under 32KiBge_32k_lt_64k - 32KiB to under 64KiBge_64k_lt_512k - 64KiB to under 512KiBge_512k - 512KiB and larger

6.2.4 InfiniBox Capacity Entities

Pool Capacity

Pool capacity entities have the following data fields:

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"physical_capacity - the pool's physical capacity in bytesvirtual_capacity - the pool's virtual capacity in bytesfree_physical_space - the amount of free physical space in bytesfree_virtual_space - the amount of free virtual space in bytesallocated_physical_space - the amount of allocated physical space in bytesallocated_virtual_space - the amount of allocated virtual space in bytesfilesystems_count - number of filesystems in the poolsnapshots_count - number of volume snapshots in the poolvolumes_count - number of volumes in the poolfilesystem_snapshots_count - number of filesystem snapshots in the poolclones_count - obsolete

6.2.5 InfiniGuard Entities

Dedup Engine

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"inline_performance - total aggregated inline traffic from all protocols, both deduplicated and non-deduplicatedtotal_disk_capacity - the total storage space in bytesavailable_disk_capacity - the unused storage space in bytesused_disk_capacity - the used storage space in bytesdata_size_before_reduction - the amount of data written before reduction, in bytesdata_size_after_reduction - the amount of data written after reduction, in bytestotal_reduction_ratio - the data reduction ratio as a string, e.g. "12.5:1"total_reduction_ratio_numeric - obsolete

Page 60: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS API  –  60

•••••••

••••••••••••••

•••••••••••

••••••

Dedup Engine Performance

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"nfs_inline - aggregated NFS protocol traffic (deduped + non-deduped)smb_inline - aggregated SMB protocol traffic (deduped + non-deduped)ost_inline - aggregated NFS protocol traffic (deduped + non-deduped)app_inline - aggregated Application Specific protocol traffic (deduped + non-deduped)vtl_inline - aggregated VTL protocol traffic (deduped + non-deduped)total_write_inline - total aggregated write (inline traffic) for all protocols, both deduplicated and non-deduplicatedtotal_read_inline -net_all_rx - Aggregated incoming traffic from all Ethernet network interfacesnet_all_tx - Aggregated outgoing traffic through all Ethernet network interfacesfc_all_rb - Aggregated read bytes from all Fibre Channel interfacesfc_all_rq - fc_all_wb - Aggregated written bytes through all Fibre Channel interfacesfc_all_wq - system_load_average -gc_stage_number -gc_stage_progress - completion rate in percentage of the current garbage collection stagegc_compaction_progress -gc_data_to_scan -gc_reclaimable_space -gc_compactable_space -

Dedup Engine Capacity

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"disk_capacity - the total storage space in bytesused_disk_capacity - the used storage space in bytesdata_not_intended_for_deduplication -deduplicated_data - total amount of deduplicated data in the system, in bytesdata_size_before_reduction - total amount of data written before reduction, in bytessystem_metadata - total amount of system metadata in the system, in bytesreclaimable_space -free_space -available_space - sum of both free and reclaimable spacetotal_deduplicated_shares - total deduplicated share data (NFS, SMB, Application Specific protocols) in bytesincoming_replication - total deduplicated data from incoming replication, in bytestotal_partitions - total deduplicated data that was backed up using the VTL protocol, in bytesost_storage_servers - total deduplicated data on OST storage servers, in bytesdedup_ratio - the deduplication ratio (numeric)compress_ratio - the compression ratio (numeric)reduction_ratio - the data reduction ratio (numeric)

Page 61: INFINIMETRICS USER GUIDE › hc › article... · by VMware for distribution purposes. It describes, in XML format, metadata related to virtual machine image. This format is supported,

INFINIMETRICS USER GUIDE

INFINIMETRICS API  –  61

••••

••••••

Dedup Engine Port Throughput

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"read_bytes - number of bytes readwrite_bytes - number of bytes writtentotal_bytes - total number of bytes

Shares, Partitions

timestamp - UTC date and time, for example "2018-05-18T00:31:02Z"user_data_size -input_bytes -unique_bytes_pre_compression -unique_bytes_post_compression -type - one of NFS, CIFS, OST, APP (for shares) or VTL (for partitions)