Reviewing and Resolving Ingest Events

If a usage data measurement you submit to the platform fails to ingest properly, then an ingest validation failure system Event is generated:

  • ingest.validation.failure

In the Usage section of the Console on the Ingest Events page, you can review and follow-up on ingest failure Events to troubleshoot and resolve them. When you have followed-up on an ingest failure Event and resolved it, you can select Mark as actioned and remove it from the Ingest Events list:

Reviewing Ingest Events

To review and resolve ingest failure Events:

1. In the Console, select Usage>Ingest Events. The Ingest Events page opens and lists ingest failure Events generated for your Organization:

You can read-off the details of the Event:

  • NAME. The Event type.

  • DATE. The date and time of the Event.

  • TYPE. The error that occurred and caused the ingest failure, which can be one of three kinds:

    • MissingField. A field required to successfully ingest the measurement is missing. For example, this could be a Data Field defined for the Meter:

      • Consequences: The submitted usage data measurement is not ingested.

    • CalculationError. If the Meter has a Derived Field, then the calculation defined for this field could not be evaluated:

      • Consequences: The submitted usage data measurement is ingested but the Derived Field value will be null.

    • DuplicateUid. A non-unique, duplicate UID was used for the measurement submission:

      • Consequences: The submitted usage data measurement is not ingested.

  • A Download log button is provided for each failure Event.

2. If you want to follow-up and investigate the ingest failure, you can select the Download log button for the Event:

  • A error log text file in JSON format is downloaded.

3. Open the downloaded log file. The file contains details of the error that caused the ingest failure, along with the original measurement to help identify and resolve the issue. For example:

In this example downloaded log file for an ingest failure caused by a CalculationError, we can see that a Derived Field on the Meter used for the ingest measurement could not be evaluated because a Data Field referenced by the Derived Field's calculation was not defined.

Note: Delay in Ingest Failure Events Showing? There can a delay of one to two minutes before an ingest failure shows on the Ingest Events page.

Tip: Batch Submissions? If you submit a set of usage data measurements as a batch submission, then all good measurements are ingested but any that provoke a MissingField or DuplicateUid error are blocked and do not get ingested.

Marking Ingest Events as Actioned

When you have followed-up and resolved an Ingest Event, you can mark it as actioned to remove it from the list.

To mark an Ingest Event as actioned and remove it from the list:

1. Select the checkbox of the Event you want to mark as actioned.

2. Select the Mark as actioned button. A confirmation popup appears:

3. Select Yes to confirm. The page refreshes and the checked Event is removed from the Events list.

Tip: Mark multiple Events as actioned? You can check-off multiple Events to mark them all as actioned at the same time.

4. If you want to check again on Events that you've already actioned, enable the Include actioned events? switch. The page refreshes and any actioned Events are added back into the Events list, and are clearly marked as ACTIONED:

Next: Submitting Test Usage Data