Skip to content

Reuse field names across different event types in EventSinkService #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lmarini merged 2 commits into from
Mar 11, 2021
Merged

Reuse field names across different event types in EventSinkService #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a30f881
Match EventSinkService fields to spreadsheet
bodom0015 Mar 9, 2021
b51fdf6
Inject timestamp when sending event, turn down logging
bodom0015 Mar 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased

### Changed

- Consolidated field names sent by the EventSinkService to maxaimize reuse.

## 1.15.0 - 2021-03-03

### Added
Expand Down
181 changes: 89 additions & 92 deletions app/services/EventSinkService.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,21 @@ import java.net.URI
import java.time.Instant
import play.api.{Logger, Play}
import play.api.Play.current
import play.api.libs.json.{JsValue, Json}
import play.api.libs.json.{JsObject, JsValue, Json}

object EventSinkService {
val EXCHANGE_NAME_CONFIG_KEY = "eventsink.exchangename"
val QUEUE_NAME_CONFIG_KEY = "eventsink.queuename"

val EXCHANGE_NAME_DEFAULT_VALUE = "clowder.metrics"
val QUEUE_NAME_DEFAULT_VALUE = "event.sink"

// TODO: Make sure these match the real config key names
val AMPLITUDE_CONFIG_KEY = "amplitude.apikey"
val GA_CONFIG_KEY = "google.analytics"
val INFLUX_AUTH_CONFIG_KEY = "influx.uri"
val MONGO_AUTH_CONFIG_KEY = "mongo.uri"
}

class EventSinkService {
val messageService: MessageService = DI.injector.getInstance(classOf[MessageService])
val userService: UserService = DI.injector.getInstance(classOf[UserService])
val appConfig: AppConfigurationService = DI.injector.getInstance(classOf[AppConfigurationService])

// UNUSED: Fetch directly from config on demand
def getGoogleAnalytics(): String = Play.configuration.getString(EventSinkService.GA_CONFIG_KEY).getOrElse("")
def getAmplitudeApiKey(): String = Play.configuration.getString(EventSinkService.AMPLITUDE_CONFIG_KEY).getOrElse("")
def getMongoAuth(): String = Play.configuration.getString(EventSinkService.AMPLITUDE_CONFIG_KEY).getOrElse("")
def getInfluxAuth(): String = Play.configuration.getString(EventSinkService.INFLUX_AUTH_CONFIG_KEY).getOrElse("")

/** Event Sink exchange name in RabbitMQ */
val exchangeName = Play.configuration.getString(EventSinkService.EXCHANGE_NAME_CONFIG_KEY)
.getOrElse(EventSinkService.EXCHANGE_NAME_DEFAULT_VALUE)
Expand All @@ -41,20 +29,18 @@ class EventSinkService {
val queueName = Play.configuration.getString(EventSinkService.QUEUE_NAME_CONFIG_KEY)
.getOrElse(EventSinkService.QUEUE_NAME_DEFAULT_VALUE)

def logEvent(category: String, metadata: JsValue) = {
Logger.info("eventsink.exchangename=" + exchangeName)
Logger.info("eventsink.queueName=" + queueName)

Logger.info("Submitting message to event sink exchange: " + Json.stringify(metadata))

//val message = EventSinkMessage(Instant.now().getEpochSecond, category, metadata)
messageService.submit(exchangeName, queueName, metadata, "fanout")
def logEvent(message: JsValue) = {
// Inject timestamp before logging the event
val event = message.as[JsObject] + ("created" -> Json.toJson(java.util.Date.from(Instant.now())))
Logger.info("Submitting message to event sink exchange: " + Json.stringify(event))
messageService.submit(exchangeName, queueName, event, "fanout")
}

/** Log an event when user signs up */
def logUserSignupEvent(user: User) = {
Logger.info("New user signed up: " + user.id.stringify)
logEvent("user_activity", Json.obj(
Logger.debug("New user signed up: " + user.id.stringify)
logEvent(Json.obj(
"category" -> "user_activity",
"type" -> "signup",
"user_id" -> user.id,
"user_name" -> user.fullName
Expand All @@ -63,8 +49,9 @@ class EventSinkService {

/** Log an event when user logs in */
def logUserLoginEvent(user: User) = {
Logger.info("User logged in: " + user.id.stringify)
logEvent("user_activity", Json.obj(
Logger.debug("User logged in: " + user.id.stringify)
logEvent(Json.obj(
"category" -> "user_activity",
"type" -> "login",
"user_id" -> user.id,
"user_name" -> user.fullName
Expand All @@ -73,191 +60,201 @@ class EventSinkService {

/** Log an event when user views a dataset */
def logDatasetViewEvent(dataset: Dataset, viewer: Option[User]) = {
Logger.info("User viewed a dataset: " + dataset.id.stringify)
logEvent("view_resource", Json.obj(
Logger.debug("User viewed a dataset: " + dataset.id.stringify)
logEvent(Json.obj(
"category" -> "view_resource",
"type" -> "dataset",
"resource_id" -> dataset.id,
"resource_name" -> dataset.name,
"author_id" -> dataset.author.id,
"author_name" -> dataset.author.fullName,
"viewer_id" -> viewer.get.id,
"viewer_name" -> viewer.get.getMiniUser.fullName
"user_id" -> viewer.get.id,
"user_name" -> viewer.get.getMiniUser.fullName
))
}

/** Log an event when user views a file */
def logFileViewEvent(file: File, viewer: Option[User]) = {
Logger.info("User viewed a file: " + file.id.stringify)
logEvent("view_resource", Json.obj(
Logger.debug("User viewed a file: " + file.id.stringify)
logEvent(Json.obj(
"category" -> "view_resource",
"type" -> "file",
"resource_id" -> file.id,
"resource_name" -> file.filename,
"author_id" -> file.author.id,
"author_name" -> file.author.fullName,
"viewer_id" -> viewer.get.id,
"viewer_name" -> viewer.get.getMiniUser.fullName
"user_id" -> viewer.get.id,
"user_name" -> viewer.get.getMiniUser.fullName
))
}

/** Log an event when user views a collection */
def logCollectionViewEvent(collection: Collection, viewer: Option[User]) = {
Logger.info("User viewed a collection: " + collection.id.stringify)
logEvent("view_resource", Json.obj(
Logger.debug("User viewed a collection: " + collection.id.stringify)
logEvent(Json.obj(
"category" -> "view_resource",
"type" -> "collection",
"resource_id" -> collection.id,
"resource_name" -> collection.name,
"author_id" -> collection.author.id,
"author_name" -> collection.author.fullName,
"viewer_id" -> viewer.get.id,
"viewer_name" -> viewer.get.getMiniUser.fullName
"user_id" -> viewer.get.id,
"user_name" -> viewer.get.getMiniUser.fullName
))
}

/** Log an event when user views a space */
def logSpaceViewEvent(space: ProjectSpace, viewer: Option[User]) = {
Logger.info("User viewed a space: " + space.id.stringify)
Logger.debug("User viewed a space: " + space.id.stringify)
(viewer, userService.get(space.creator)) match {
case (Some(v), Some(author)) => {
logEvent("view_resource", Json.obj(
logEvent(Json.obj(
"category" -> "view_resource",
"type" -> "space",
"resource_id" -> space.id,
"resource_name" -> space.name,
"author_id" -> space.creator.stringify,
"author_name" -> author.fullName,
"viewer_id" -> v.id,
"viewer_name" -> v.getMiniUser.fullName
"user_id" -> v.id,
"user_name" -> v.getMiniUser.fullName
))
}
case (None, Some(author)) => {
logEvent("view_resource", Json.obj(
logEvent(Json.obj(
"category" -> "view_resource",
"type" -> "space",
"resource_id" -> space.id,
"resource_name" -> space.name,
"author_id" -> author.id,
"author_name" -> author.fullName,
"viewer_id" -> "",
"viewer_name" -> "Anonymous"
"user_id" -> "",
"user_name" -> "Anonymous"
))
}
case (Some(v), None) => {
// TODO: Is this a real case? Is this needed?
logEvent("view_resource", Json.obj(
logEvent(Json.obj(
"category" -> "view_resource",
"type" -> "space",
"resource_id" -> space.id,
"resource_name" -> space.name,
"author_id" -> space.creator.stringify,
"author_name" -> "",
"viewer_id" -> v.id,
"viewer_name" -> v.getMiniUser.fullName
"user_id" -> v.id,
"user_name" -> v.getMiniUser.fullName
))
}
case (None, None) => {
// TODO: Is this a real case? Is this needed?
logEvent("view_resource", Json.obj(
logEvent(Json.obj(
"category" -> "view_resource",
"type" -> "space",
"resource_id" -> space.id,
"resource_name" -> space.name,
"author_id" -> space.creator.stringify,
"author_name" -> "",
"viewer_id" -> "",
"viewer_name" -> "Anonymous"
"user_id" -> "",
"user_name" -> "Anonymous"
))
}
}
}

def logSubmitFileToExtractorEvent(file: File, extractorName: String, submitter: Option[User]) = {
logEvent("extraction", Json.obj(
logEvent(Json.obj(
"category" -> "extraction",
"type" -> "file",
"extractor_name" -> extractorName,
"resource_id" -> file.id,
"resource_name" -> file.filename,
"author_id" -> file.author.id,
"author_name" -> file.author.fullName,
"submitter_id" -> submitter.get.id,
"submitter_name" -> submitter.get.getMiniUser.fullName
"user_id" -> submitter.get.id,
"user_name" -> submitter.get.getMiniUser.fullName
))
}

def logSubmitDatasetToExtractorEvent(dataset: Dataset, extractorName: String, submitter: Option[User]) = {
logEvent("extraction", Json.obj(
logEvent(Json.obj(
"category" -> "extraction",
"type" -> "dataset",
"extractor_name" -> extractorName,
"resource_id" -> dataset.id,
"resource_name" -> dataset.name,
"author_id" -> dataset.author.id,
"author_name" -> dataset.author.fullName,
"submitter_id" -> submitter.get.id,
"submitter_name" -> submitter.get.getMiniUser.fullName
"user_id" -> submitter.get.id,
"user_name" -> submitter.get.getMiniUser.fullName
))
}

def logSubmitSelectionToExtractorEvent(dataset: Dataset, extractorName: String, submitter: Option[User]) = {
// TODO: Is this a real case? Is this needed?
logEvent("extraction", Json.obj(
logEvent(Json.obj(
"category" -> "extraction",
"type" -> "selection",
"extractor_name" -> extractorName,
"resource_id" -> dataset.id,
"resource_name" -> dataset.name,
"author_id" -> dataset.author.id,
"author_name" -> dataset.author.fullName,
"submitter_id" -> submitter.get.id,
"submitter_name" -> submitter.get.getMiniUser.fullName
"user_id" -> submitter.get.id,
"user_name" -> submitter.get.getMiniUser.fullName
))
}

def logFileUploadEvent(file: File, dataset: Option[Dataset], uploader: Option[User]) = {
dataset match {
case Some(d) => {
logEvent("upload", Json.obj(
logEvent(Json.obj(
"category" -> "upload",
"dataset_id" -> d.id,
"dataset_name" -> d.name,
"dataset_author_name" -> d.author.fullName,
"dataset_author_id" -> d.author.id,
"uploader_id" -> uploader.get.id,
"uploader_name" -> uploader.get.getMiniUser.fullName,
"filename" -> file.filename,
"length" -> file.length
"author_name" -> d.author.fullName,
"author_id" -> d.author.id,
"user_id" -> uploader.get.id,
"user_name" -> uploader.get.getMiniUser.fullName,
"resource_name" -> file.filename,
"size" -> file.length
))
}
case None => {
logEvent("upload", Json.obj(
"uploader_id" -> uploader.get.id,
"uploader_name" -> uploader.get.getMiniUser.fullName,
"filename" -> file.filename,
"length" -> file.length
logEvent(Json.obj(
"category" -> "upload",
"user_id" -> uploader.get.id,
"user_name" -> uploader.get.getMiniUser.fullName,
"resource_name" -> file.filename,
"size" -> file.length
))
}
}
}

def logFileDownloadEvent(file: File, /*dataset: Dataset,*/ downloader: Option[User]) = {
logEvent("download", Json.obj(
/*"dataset_id" -> dataset.id,
"dataset_name" -> dataset.name,
"dataset_author_name" -> dataset.author.fullName,
"dataset_author_id" -> dataset.author.id,*/
def logFileDownloadEvent(file: File, downloader: Option[User]) = {
logEvent(Json.obj(
"category" -> "download",
"type" -> "file",
"uploader_id" -> file.author.id,
"uploader_name" -> file.author.fullName,
"downloader_id" -> downloader.get.id,
"downloader_name" -> downloader.get.getMiniUser.fullName,
"filename" -> file.filename,
"length" -> file.length
"resource_id" -> file.id,
"resource_name" -> file.filename,
"author_id" -> file.author.id,
"author_name" -> file.author.fullName,
"user_id" -> downloader.get.id,
"user_name" -> downloader.get.getMiniUser.fullName,
"size" -> file.length
))
}

def logDatasetDownloadEvent(dataset: Dataset, downloader: Option[User]) = {
logEvent("download", Json.obj(
logEvent(Json.obj(
"category" -> "download",
"type" -> "dataset",
"dataset_id" -> dataset.id,
"dataset_name" -> dataset.name,
"dataset_author_name" -> dataset.author.fullName,
"dataset_author_id" -> dataset.author.id,
"downloader_id" -> downloader.get.id,
"downloader_name" -> downloader.get.getMiniUser.fullName,
"files_length" -> dataset.files.length,
"folder_length" -> dataset.folders.length
"resource_id" -> dataset.id,
"resource_name" -> dataset.name,
"author_name" -> dataset.author.fullName,
"author_id" -> dataset.author.id,
"user_id" -> downloader.get.id,
"user_name" -> downloader.get.getMiniUser.fullName,
"size" -> (dataset.files.length + dataset.folders.length)
))
}
}
Expand Down