Monitor Data Usage and Generate Reports

HERE Marketplace enables you to review your subscribers data usage and generate reports. Marketplace reports on two types of metrics, input and output. The input metrics represent the data that is published by the Provider and can be calculated via Bytes, APIs, or Messages. The output metric represents the data that is consumed by the Consumer and can be calculated via Bytes, APIs.

The platform allows using HTTP and/or Kafka connectors read from or write data to a stream layer. You can get metrics in the form of API calls when HTTP connectors are used or bytes in case of Direct Kafka connector.

You can generate reports for the catalog-based and the Neutral Server listing subscriptions.

Usage metrics for the catalog-based subscription

When using HTTP connector, you receive data in the form of API calls:

  1. API-Calls-In: The number of successful (aka. returns 2xx codes) PUT & POST methods being invoked. This metric applies to all data layer types.
  2. API-Calls-Out: The number of successful (aka. returns 2xx codes) HTTP GET methods returned. This metric applies to all data layer types and Neutral Server containers.
  3. Bytes_in: The volume of data published to a layer by a Provider. This metric applies to all data layer types.
  4. Bytes_out: The volume of data consumed from a layer. This metric applies to all data layer types.
  5. Messages_in: The number of discrete (unique) data objects that are available. This metric is only relevant to the streaming layer.

When using Kafka connector, you receive data in bytes:

  1. Bytes_in: The volume of data published to a layer by a Provider. This metric applies to all data layer types.
  2. Bytes_out: The volume of data consumed from a layer. This metric applies to all data layer types.

Note

API calls usage metrics would not be available if you read or write data via Kafka connector.

Usage metrics will be slightly higher than actual payload due to Kafka overhead and extra metadata.For Provider, the overhead is low. For Consumer, overhead is accumulated while there is a running Consumer. If Consumer has a 24/7 running pipeline to pull data from the stream layer and there is nothing that was ever published to this layer –, there still would be bytes_out metrics reported. The approximate overhead is 150bytes-1k/s, depending on how many partitions exist in the topic.

Usage metrics for the Neutral Server subscription

  1. No. of VIDs: The number of unique vehicle IDs that data Consumer retrieved from Neutral Server containers during the reporting period.
  2. API-Calls-Out: The number of successful (aka. returns 2xx codes) HTTP GET methods returned. This metric applies to all data layer types and Neutral Server containers.

Monitor Data Usage

  1. From the HERE platform, click Marketplace > Subscriptions Sold.
  2. Select a subscription to view details.
  3. Configure the reporting period by selecting Start Date and End Date.
Generate usage report for a catalog-based subscription
Figure 1. Generate usage report for a catalog-based subscription
Generate usage report for a Neutral Server subscription
Figure 2. Generate usage report for a Neutral Server subscription

Note

HERE recommends using bytes to estimate volume of usage for billing purposes.

Real-time data might lag under certain circumstances.

Generate Reports

  1. From the HERE platform portal, click Marketplace > Subscriptions Sold.
  2. Select the Marketplace Consumer you want to process. The Subscriptions Sold screen appears.
  3. Select the subscription you want to review.
  4. Click Generate report.

Note

It takes some time for the usage metrics data to update. When generating a report, allow at least 72 hours for accuracy.

results matching ""

    No results matching ""