StreamEnrich monitoring heartbeat event: wrong property

boba · March 13, 2020, 8:09pm

I believe I found a bug in how monitoring heartbeat events are sent in scala stream enrich.

The schema asks for interval property:

snowplow/iglu-central/blob/master/schemas/com.snowplowanalytics.monitoring.kinesis/app_heartbeat/jsonschema/1-0-0#L14


	"self": {
		"vendor": "com.snowplowanalytics.monitoring.kinesis",
		"name": "app_heartbeat",
		"format": "jsonschema",
		"version": "1-0-0"
	},


	"type": "object",


	"properties": {
		"interval": {
			"type": "number"
		}
	},


	"additionalProperties": false
}

The enricher sends internal property:

github.com

snowplow/snowplow/blob/master/3-enrich/stream-enrich/core/src/main/scala/com.snowplowanalytics.snowplow.enrich.stream/SnowplowTracking.scala#L188


   */
  private def trackApplicationHeartbeat(tracker: Tracker[Id], heartbeatInterval: Long): Unit =
    tracker.trackSelfDescribingEvent(
      SelfDescribingData[Json](
        SchemaKey(
          "com.snowplowanalytics.monitoring.kinesis",
          "app_heartbeat",
          "jsonschema",
          SchemaVer.Full(1, 0, 0)
        ),
        Json.obj(("internal", Json.fromLong(heartbeatInterval)))
      )
    )
}

Is this the right place to post things like this? Or should I create an issue on github?

mike · March 14, 2020, 12:12am

Good catch @boba - I think a Github issue is probably best for this (or even better a PR!).

eunice · January 25, 2021, 11:38am

Stumbled upon this since we are facing similar issue with our heartbeat events.

@boba @mike Any update on this? I’m happy to do the PR, if this hasn’t been fixed or a fix is still not on its way.

mike · January 26, 2021, 9:30pm

Thanks for the reminder.

I’ve submitted a PR to fix this as it looks like this is still a bug - Rename 'internal' to 'interval'. Fixes #410 by miike · Pull Request #411 · snowplow/enrich · GitHub