Introduction

OpsRamp supports the installation of a collector in both virtualized and cloud-native environments. The installation process in both environments is achieved in a single unified flow as shown below.

Add Gateway Collector Profile

Follow these steps to add a gateway collector profile:

  1. Navigate to Setup > Account. The Account Details page appears.

  2. Click the Collector Profiles tile. The Collector Profiles page appears.

  3. Click +Add.

    Add Collector Profile

  4. Enter following details in the gateway collector profile page:

    • Enter a profile name
    • Provide the short description (Optional)
    • Select a profile type

  5. Select one of the collector from below as per your requirement:

    • Classic
      • Amazon Machine Image
      • Virtual Appliance (ISO)
      • Virtual Appliance (OVA)
      • Azure Blob Container
      • Google Image
    • NextGen
      • Virtual Appliance (ISO)
      • Virtual Appliance (OVA)
      • Cloud-Native Application (Installer)
    • Windows
      • Installer for Windows OS

  6. Click Next. Based on the collector selected, the instructions in the Installation and Activation tabs differ.

    Install gateway collector

  7. Follow the instructions in the Installation tab.

  8. Download the required file.

  9. Click on Activation tab. Follow the instructions.
    Information like URL, System username, password, Admin username and password appears.

    • You can retrieve the default credentials (username and password) for System user and Admin user and change them when required.
      Note: Default passwords vary based on the gateway type and the installed gateway version.

    Activation screen

  10. Follow the instructions to install and register the Gateway Collector.

  11. Click Finish. The gateway is added to the collector profile.

See Classic Gateways and NextGen Gateways for more information on installing a gateway.

After creating the collector profile and installing the gateway and registering it, you can see all the collector profiles in the Collector Profiles listing page.

Collector Profiles listing page

  • DOWNLOAD COLLECTOR: Click this option available at the top-right corner of the page, and follow the instructions on the GATEWAY COLLECTORS page to download the collector.
  • REFRESH: Click the Refresh option to refresh the Collector Profiles listing page.

Collector Profiles table: Column reference

The Collector Profiles listing page consists of the following columns:

ColumnDescription
NameName of the Collector Profile.
StatusDisplays the status of the collector profile:
  • Not Installed: The gateway has not yet been registered against this collector profile.
  • Disconnected: The tunnel between the Gateway resource and the OpsRamp SaaS portal is inactive or unreachable.
  • Connected: The tunnel between the Gateway resource and the OpsRamp SaaS portal is active and operational.
Gateway Resource NameName of the gateway resource associated with this profile.
TypeType of gateway: NextGen, Classic, or Windows.
VersionInstalled gateway version.
Model NumberModel number of installed gateways.
(Example: Classic gateway model number starts with OG, NextGen starts with ONG, Windows starts with OWG).
Profile TypeStandard: A fixed-capacity profile designed for stable, predictable workloads.
Elastic: A scalable profile designed for horizontal scaling by adding replica profiles (child gateway profiles) to increase capacity and distribute workload.
Note: Elastic profile type is applicable only to NextGen Gateway.
Replica Profile CountNumber of replica profiles associated with the collector profile.
Note: This field will have a value only if the Profile type is Elastic.
Upgrade StatePatch availability of the gateway.
Not Available - When the Gateway is with unsupported version, and there is no patch available for the specific gateway registered model.
Up-to-date - Profile is running the latest gateway version.
Upgrade Available - A newer version is available for the gateway.
Upgrade on Schedule - A gateway upgrade is already scheduled for this gateway.
Not Allowed - Filters gateways where a firmware upgrade is available in the patch but is currently blocked or restricted from being applied.
Upgrade StatusStatus of the latest upgrade operation.
  • Not Installed: The gateway has not yet been registered against this collector profile.
  • Disconnected: The tunnel between the Gateway resource and the OpsRamp SaaS portal is inactive or unreachable.
  • Connected: The tunnel between the Gateway resource and the OpsRamp SaaS portal is active and operational.
Client Name (visible only in Partner scope.)Name of the client associated with the collector profile.

Collector Profile summary panel

The Collector Profile summary panel displays additional information about a selected collector profile, organized into three sections (Overview, Configurations, Capabilities) for better clarity and accessibility:

  1. Navigate to Setup > Account. The Account Details page appears.
  2. Click the Collector Profiles tile. The Collector Profiles listing page appears.
  3. Search for the collector profile you want to view the summary.
  4. Click anywhere on the row. The collector profile summary panel appears on the right side of the page.

    Collector Profile Summary Panel

Overview

Displays high-level details of the selected collector profile:

FieldDescription
Client NameName of the client associated with the collector profile. (Partner scope only)
Gateway Resource NameName of the gateway resource associated with this profile.
VersionInstalled gateway version.
Model NumberModel number of installed gateway.
Example: ONG, OGV, OGA
UUIDUnique identifier of the collector profile.
NamespaceKubernetes namespace or logical grouping.
All NextGen Gateways show the Kubernetes namespace in which the gateway is deployed.
For Classic and Windows Gateways, this field displays N/A
Profile TypeStandard: A fixed-capacity profile designed for stable, predictable workloads.
Elastic: A scalable profile designed for horizontal scaling by adding replica profiles (child gateway profiles) to increase capacity and distribute workload.
Note: Elastic profile type is applicable only to NextGen Gateway.
Replica Profile CountNumber of replica profiles associated with the collector profile.
Note: This field will have a value only if the Profile type is Elastic.
Upgrade StatePatch availability of the gateway.
Not Available - When the Gateway is with unsupported version, and there is no patch available for the specific gateway registered model.
Up-to-date - Profile is running the latest gateway version.
Upgrade Available - A newer version is available for the gateway.
Upgrade on Schedule - A gateway upgrade is already scheduled for this gateway.
Not Allowed - Filters gateways where a firmware upgrade is available in the patch but is currently blocked or restricted from being applied.
Upgrade StatusStatus of the latest upgrade operation.
  • Not Installed: The gateway has not yet been registered against this collector profile.
  • Disconnected: The tunnel between the Gateway resource and the OpsRamp SaaS portal is inactive or unreachable.
  • Connected: The tunnel between the Gateway resource and the OpsRamp SaaS portal is active and operational.

Configurations

Provides visibility into the configuration artifacts associated with the collector profile:

FieldDescription
Installed AppsNumber of applications installed on the collector profile.
Discovery ProfilesNumber of discovery profiles configured for the collector profile.
Managed ResourcesNumber of resources managed by the collector profile.
Syslog Monitor ConfigurationsNumber of syslog monitor configurations mapped to the collector profile.
AgentsNumber of agents using this gateway as a proxy.
MetricsCount of active metrics retrieved from gateway resources over the last 15 minutes.
TemplatesNumber of unique monitoring templates applied across all managed resources under the collector profile.

Capabilities

Displays supported capabilities along with their enabled/disabled states:

FieldDescription
Gateway Managed OTel Collector (Enabled/Disabled – NextGen only)Manages OpenTelemetry collectors directly on the NextGen gateway for advanced observability and data collection.
SIP Agent (Enabled/Disabled – Classic only)Monitors SIP protocol traffic and call signaling for Classic gateways.
Synthetics Agent (Enabled/Disabled – Classic & NextGen)Performs synthetic monitoring and proactive testing of applications and services.
Traffic DirectorRoutes and directs network traffic according to configured policies and rules.
Note: This is applicable for only NextGen Gateways deployed on AWS EKS.

Note: You can directly manage the SIP Agent and Synthetics Agent from this section.

Filter

You can use the Filter option to narrow down search results.

  1. Navigate to Setup > Account. The Account Details page appears.
  2. Click the Collector Profiles tile. A list of collector profiles appears.
  3. Click the FILTER option at the upper-right corner of the page.

    Collector Profiles - Filter
  4. Select the filters based on your requirement.
  5. Click FILTER. The search result appears.

Actions on a collector profile

Following are the options that appear on the Collector Profiles listing page.

  • The options appear based on the Gateway status.
  • Your scope determines which actions you can perform.
    Client Scope: Access to all actions.
    Partner Scope: Access is restricted to Rename, Remove, Enable Debug Console, and Copy ID.
ActionDescription
Run remote commandThis option appears only if the Gateway is in the Connected state (The SNMP Walk cannot be executed when the Gateway is down).
The Run Remote Command is used to execute SNMP commands on remote devices.
To run a remote command:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Run remote command.
    The RUN REMOTE COMMAND window appears.
    1. The command type is SNMP Full Walk, by default.
    2. Enter the target device IP address.
    3. Select an existing SNMP Credential from the dropdown or add a credential.
    4. Click EXECUTE SNMP FULL WALK. This triggers the remote command execution.
The SNMP FULL WALK section displays the following information:
  • IpAddress Column: Shows the IP address of the device queried.
  • Status Column: Displays the execution status of the command.
Refresh: Click Refresh to refresh the results without re-executing.
RenameTo rename a collector profile:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Rename.
  4. Enter a name and click Rename.
DetachTo detach a collector profile:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Detach. A confirmation message appears,
    • Monitoring associated with this gateway will stop.
    • The gateway will be disconnected from the collector profile.
    • The agent installed on the gateway will be uninstalled
    • If the gateway is used as a proxy server, the agents connecting via the gateway will be disconnected and the squid proxy server configuration will be reset.
    • All network settings will be reset.
    • The gateway will stop receiving Syslog or SNMP Traps.
    • The gateway will be reset to its default settings and rebooted.
  4. Click Detach.
ReinstallTo reinstall a collector profile:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Reinstall. A confirmation popup appears.
  4. Click Install. Follow the instructions to install and register the gateway.
RemoveTo remove a collector profile:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Remove. A confirmation popup appears. The Gateway Collector profile will not be deleted if the profile has Installed App, Discovery Profiles, or Managed Resources.
    Note: The Remove button is disabled, if there are installed apps, discovery profiles, or managed resources.
  4. Click Remove.
Scale UpScale Up is available only for Elastic type collector profile.
To scale up:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Scale Up. A confirmation popup appears.
    The Scale Up action will create one more gateway child profile, and this action will increase the capacity of the gateway profile. The Re-balance will be performed automatically once after the scale-up operation is initiated. If for any reason re-balance does not happen, you have the flexibility to do it manually using the re-balance option. After doing the Scale Up action the load will be distributed equally.
  4. Click Scale Up.
Scale DownScale Down is available only for Elastic type collector profile.
Use this option when there are limited resources running and you do not want an additional profile.
To scale down:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Scale Down. A confirmation popup appears.
    The Scale Down action will remove the recently created child profile. If you want to remove all the child profiles, you can rerun the same operation until the child replicas get removed and finally all the resources will be running under the actual parent profile.
  4. Click Scale Down.
RebalanceRebalance is available only for Elastic type collector profile.
Use this option to distribute resources evenly across profiles.
To Rebalance:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Click Rebalance.
Reboot Gateway (Only available for Classic Gateways)To reboot the gateway:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Reboot Gateway. A confirmation popup appears.
  4. Click Reboot Gateway. The gateway is restarted.
Reset Password (Available for Classic & NextGen Gateways)To reset the gateway password:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Reset Password. A confirmation popup appears.
  4. Click Reset Password. The gateway password is set to default password.
Enable Debug Console (available for NextGen Gateways)To enable debug console:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Enable Debug Console. A popup appears, The debug pod will be deployed on the gateway, activating the debug console and attaching it to the gateway device.
  4. Click Enable Debug Console.
Copy IdTo copy gateway UUID:
  1. Search for the collector profile.
  2. Hover over the row and click the action menu (three dots).
  3. Select Copy Id. A confirmation popup appears, ID copied successfully.
The gateway UUID is copied to the clipboard.

Upgrade gateway

You can upgrade a gateway from the current version to the next available versions.

Prerequisite: The collector profile should be in Connected status.

To upgrade a gateway:

  1. Navigate to Setup > Account. The Account Details page appears.

  2. Click the Collector Profiles tile. A list of collector profiles appears.

  3. Search for the collector profile you want to upgrade.

  4. Use the checkbox to select the profile.

    Upgrade gateway

  5. Click Upgrade. The Upgrade Gateway Version window appears.

    Upgrade gateway window

  6. Select a version you want to upgrade from the Upgrade Version dropdown. As soon as you select the version, pre-upgrade checks run. A confirmation message appears once the checks are run successfully.
    Note: The most recent patch for the supported major versions would be available in the dropdown.

    Upgrade gateway pre-checks
    If all the check points (Disk, Memory, CPU, Connectivity, System Packages) are healthy, the Pre-Upgrade Check Status column shows pass. If the checks are unhealthy, it shows fail.

  7. Choose one of the following upgrade options:

    • To directly upgrade: Click UPGRADE to start the upgrade immediately.
    • To schedule upgrade: Check the UPGRADE ON SCHEDULE checkbox. Select the date and time for the scheduled upgrade in the Schedule details field. The date and time should be in UTC. Click UPGRADE to schedule the upgrade.

      Schedule Upgrade gateway

    A confirmation popup appears, The gateways will be temporarily unavailable during the upgrade process.

The collector profile is upgraded to the specified version.

Edit Collector Profile

Below are the allowed modifications on a collector profile based on gateway state:

  • NOT INSTALLED: All fields can be modified.
  • CONNECTED/DISCONNECTED: Only profile name and description can be modified.

Follow these steps to edit Collector Profile details:

  1. Navigate to Setup > Account. The Account Details page appears.
  2. Click the Collector Profiles tile. The Collector Profiles listing page appears.
  3. Search for the collector profile you want to make changes.
  4. Click the collector profile name. The EDIT GATEWAY COLLECTOR PROFILE page appears.
  5. Make the necessary changes. Follow the steps in the Add Gateway Collector Profile section.
  6. Click SAVE.

Collector Profile management - Connected state

When the gateway is in a CONNECTED state, the following actions are available on the collector profile details page:

Connected gateway - Actions

ColumnDescription
Reset PasswordThe gateway password is reset to default password.
Reboot CollectorThe gateway will restart.
Sync SNMP DefinitionsSynchronizes all the SNMP Definitions between the cloud and the selected gateway.
Enable/Disable SIP AgentSelect to enable or disable the SIP Agent.
Enable/Disable Synthetics AgentSelect to enable or disable the Synthetics Agent.
RemoveClick to Remove the profile.
Note: Gateway Collector profile will not be deleted, if the profile has Installed App, Discovery Profiles, Managed Resources, or Syslog Monitor Configurations.