Configure Application Metadata Exporter Application

To add AMX application:

  1. Go to Traffic > Virtual > Orchestrated Flows and select your cloud platform. The Monitoring Session page appears.
  2. Click New Monitoring Session to create a new monitoring session. Refer to Create a Monitoring Session section in the respective cloud deployment guide for more detailed information on how to create a Monitoring Session.
  3. In the Monitoring Session Canvas page, drag and drop Application Metadata Exporter from APPLICATIONS to the graphical workspace. The Application quick view appears.
  4. Enter the Alias for the application.
  5. In the Ingestor section, enter or select the following details. Click to add another ingestor to add multiple inputs to the AMX application and click to remove an existing ingestor.

    Fields

    Description

    Name

    Enter name for the Ingestor.

    Port

    Enter the port number to which the Application Metadata or the Control Plane metadata must be ingested.

    Type

    Select any one of the following:

    AMI - Select this option if the input is AMI.

    Mobility Control Plane - Select this option if the input is Control Plane Metadata.

  6. Enter or select the following details in the Metadata Enrichment section:

    You can use the Actions button to add multiple Metadata Enrichment. Keep in mind the following when configuring multiple Metadata Enrichment:

    • You can only configure either Mobility or Workload enrichment
    • You can only configure one Metadata enrichment with either Mobility or Workload as the Type
    • You can only configure a maximum of 5 Metadata enrichment with Others as the Type.

    Fields

    Description

    Enrichment Name

    Enter a unique name for each enrichment.

    Enable

    Use this option to enable the enrichment.

    Type

    Select the type from the drop-down menu.

    o Mobility
    o Workload
    o Others

    Mobility

    Attribute Fields

    Select the attributes from the list. You can use the Select All option to select all the available attributes. Refer to Attributes for GigaVUE Enriched Metadata for Mobile Networks. for more detailed information on the list of available attributes and their description.

    Workload

    Platforms

    Select the platform in which your Workload Virtual Machines are present.

    VMware vCenter
    AWS
    Azure

    Attribute Fields

    Select the attributes from the list. You can use the Select All option to select all the available attributes. Refer to Attributes for GigaVUE Enriched Metadata for Cloud Workloadsfor more detailed information on the list of available attributes and their description.

    Advanced Options

    The advanced options allow you to configure additional details like interval and delay.

    Click Add. Enter the following details:

    o Enter the Key.
    o Enter the Value.

    Source Information

    Enter the details of the source.

    Name: Enter a unique name for each Source Information. The name should be unique across the ingestor and the source information.

    Key: The default keys for each platform are listed as follows. Click + to add more keys.

    AWS: Refer to Manage access keys for IAM users section in AWS documentation for more detailed information on how to create an access key ID and a secret access key.

    ■  aws_access_key_id
    ■  aws_secret_access_key
    ■  aws_region

    Azure: Refer to Register a Microsoft Entra app and create a service principal section in Azure documentation for more detailed information on how to configure client ID, client secret, tenant ID, and subscription ID in Azure.

    ■   azure_client_id
    ■   azure_client_secret
    ■  azure_tenant_id
    ■  azure_subscription_id

    VMware:

    ■  url - The URL of VMware vCenter.
    ■  username - Username of the VMware vCenter
    ■  password - vCenter password used to connect to the vCenter
    ■  self_signed_certificate

    Value: Enter the value for the keys. This field is editable after saving the changes.

    Secure Keys: Use this option to mask the value. After saving the changes, Secure Keys and Key fields are disabled and the value is masked.

    Click to add another Source Information and click to remove a Source Information. You can add multiple Source Information if your workloads are across different vCenters, AWS Accounts, or Azure Subscriptions. You can create an individual Source Information for each of the vCenters, AWS Accounts, or Azure Subscriptions.

    Others: Use this setting to perform custom mapping for advanced use cases. For details contact Gigamon Support.

    Attribute Fields

    Click Add and enter the attribute.

    Settings

    Click Add and enter the details.

  7. Enter or select the following details in Cloud Tools Export section:

    Fields

    Description

    Alias

    Enter the alias name for the cloud tool export.

    Cloud Tool

    Select the Cloud tool from the drop-down menu.

    TypeSelect any one of the following:

    ami - Select this option to export AMI.

    mobility_control - Select this option to export control plane metadata.

    ami_enriched - Select this option to export enriched metadata for cloud workloads.

    Account ID

    Enter the account ID number of the selected Cloud Tool.

    API Key

    Enter the API key of the Cloud Tool.

    Source IP AddressSource IP Address is needed when the egress interface is configured with multiple IP addresses. Configure the source IP address which is connected to the Cloud Tool. Both IPv4 and IPv6 are supported. This field is optional.

    Enable Export

    Enable the box to export the Application Metadata Intelligence output in JSON format.

    Zip

    Enable the box to compress the output file.

    Note:  Enable this field when using New Relic as the cloud tool.

    Interval

    The time interval (in seconds) in which the data should be uploaded periodically. The recommended minimum time interval is 10 seconds and the maximum time interval is 1800 seconds.

    Parallel Writer

    Specifies the number of simultaneous JSON exports done.

    Export Retries

    The number of times the application tries to export the entries to Cloud Tool. The recommended minimum value is 4 and the maximum is 10.

    Maximum Entries

    The number of JSON entries in a file. The maximum number of allowed entries is 5000 and the minimum is 10, however 1000 is the default value.

    Labels

    Click Add. Enter the following details:

    o Enter the Key .
    o Enter the Value.

    Note:  Refer to the deployment guides of the respective cloud tools for configuring the Key and Value.

  8. Enter or select the following details in the Kafka exports section:

    Fields

    Description

    Alias

    Enter the alias name for the Kafka Export.

    Topic

    The topic name to push JSON streams to, which is generally given to users part of the Kafka administration.
    TypeSelect any one of the following:

    ami - Select this option to export AMI.

    mobility_control - Select this option to export control plane metadata.

    ami-enriched - Select this option to export enriched metadata.

    Brokers

    The URL that contains the Kafka cluster endpoints. Click to add another broker and click to remove an existing broker.
    Source IP AddressSource IP Address is needed when the egress interface is configured with multiple IP addresses. Configure the source IP address which is connected to the Kafka Broker. Both IPv4 and IPv6 are supported. This field is optional.

    Enable Export

    Enable the box to export the Application Metadata Intelligence output in JSON format.

    Zip

    Enable the box to compress the output file.

    Interval

    The time interval (in seconds) in which the data should be uploaded periodically. The recommended minimum time interval is 10 seconds and the maximum time interval is 1800 seconds. The default time interval is 30 seconds.

    Parallel Writer

    Specifies the number of simultaneous JSON exports done.

    Export Retries

    The number of times the application tries to export the entries to Kafka. The recommended minimum value is 4 and the maximum is 10.

    Maximum Entries

    The number of JSON entries in a file. The maximum number of allowed entries is 5000 and the minimum is 10, however 1000 is the default value.

    Labels

    Click Add. Enter the following details:

    o Enter the Key.
    o Enter the Value.
    Producer Configurations

    Click Add to enter the authentication details if a Kafka broker needs authentication.

    For Example:

    • security.protocol=SASL_SSL
    • sasl.mechanism=PLAIN
    • sasl.username=username
    • sasl.password=password
  9. Click Deploy to deploy the monitoring session. The Select nodes to deploy the Monitoring Session dialog box appears. Select the GigaVUE V Series Node for which you wish to deploy the monitoring session.
  10. After selecting the GigaVUE V Series Node, select the interfaces for the REPs deployed in the monitoring session from the drop-down menu. Then, click Deploy.

Additional Configurations

You can perform a few additional configurations like disabling the Export Retries and edit the default value of timeout in seconds to wait for tool or server to reply back to AMX.

Follow the steps given below:

  1. Log in the GigaVUE V Series Node in which the AMX application is deployed.
  2. Create a new file using /etc/amx_settings.yaml.
  3. Add the following into the file:
    # timer window in seconds. Default is 1800s / 5min. 0 implies disable backoff logic.
    self_heal_timer_window: 0
    # timeout in seconds to wait for tool /server to reply back to AMX. NA for Kafka.
    http_client_upload_timeout: <Enter value in seconds>
  1. In GigaVUE-FM, go to Traffic > Virtual > Orchestrated Flows and select your cloud platform. Select the Monitoring Session in which the AMX application is deployed.
  2. Click Actions > Undeploy. The Monitoring session is undeployed.
  3. Select the Monitoring session undeployed in the previous step and click Actions > Deploy.

Application Monitoring Options

You can configure the traffic health monitoring for this application in the THRESHOLDS tab. You can select an existing template from the Threshold Templates drop-down menu or provide the threshold values. For more details on Traffic health monitoring and how to create threshold template, refer to Traffic Health Monitoring.

You can view the configuration health status and the traffic health status of the application in the HEALTH STATUS tab. For more details on configuration health and traffic health, refer to Monitor Cloud Health.

You can view the statistics of the application in the STATISTICS tab. Refer to View Application Statistics for Application Metadata Exporter for more detailed information.