markusthoemmes commented on a change in pull request #3421: Add ElasticSearch Log Store URL: https://github.com/apache/incubator-openwhisk/pull/3421#discussion_r174373754
########## File path: common/scala/src/main/scala/whisk/core/containerpool/logging/ElasticSearchLogStore.scala ########## @@ -0,0 +1,138 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package whisk.core.containerpool.logging + +import java.nio.file.{Path, Paths} +import java.time.LocalDate +import java.time.format.DateTimeFormatter + +import akka.actor.ActorSystem +import akka.http.scaladsl.model.HttpRequest +import akka.http.scaladsl.model.Uri +import akka.stream.scaladsl.Flow +import akka.http.scaladsl.model.HttpResponse +import akka.http.scaladsl.model._ + +import whisk.common.AkkaLogging +import whisk.core.entity.{ActivationLogs, Identity, WhiskActivation} +import whisk.core.containerpool.logging.ElasticSearchJsonProtocol._ +import whisk.core.ConfigKeys + +import scala.concurrent.Future +import scala.concurrent.Promise +import scala.util.Try + +import spray.json._ + +import pureconfig._ + +// Schema of logs in ES +case class UserLogEntry(message: String, stream: String, time: String, action: String) + +object UserLogEntry extends DefaultJsonProtocol { + implicit val serdes = + jsonFormat(UserLogEntry.apply, "message", "stream_str", "time_date", "action_str") +} + +case class ElasticSearchLogStoreConfig(protocol: String, + host: String, + port: Int, + logMessageField: String, + activationIdField: String, + requiredHeaders: String) + +/** + * Docker based implementation of a LogStore. + * + * Relies on docker's implementation details with regards to the JSON log-driver. When using the JSON log-driver + * docker writes stdout/stderr to a JSON formatted file which is read by this store. Logs are written in the + * activation record itself. + * + * Additionally writes logs to a separate file which can be processed by any backend service asynchronously. + */ +class ElasticSearchLogStore( + system: ActorSystem, + httpFlow: Option[Flow[(HttpRequest, Promise[HttpResponse]), (Try[HttpResponse], Promise[HttpResponse]), Any]] = None, + destinationDirectory: Path = Paths.get("logs"), + elasticSearchConfig: ElasticSearchLogStoreConfig = + loadConfigOrThrow[ElasticSearchLogStoreConfig](ConfigKeys.elasticSearch)) + extends DockerToActivationFileLogStore(system, destinationDirectory) { + + implicit val actorSystem = system + implicit val logging = new AkkaLogging(system.log) + + private val protocol = elasticSearchConfig.protocol + private val host = elasticSearchConfig.host + private val port = elasticSearchConfig.port + private val logMessageField = elasticSearchConfig.logMessageField + private val activationIdField = elasticSearchConfig.activationIdField + private val requiredHeaders = elasticSearchConfig.requiredHeaders.split(",") + private val esClient = new ElasticSearchRestClient(protocol, host, port, httpFlow) + + private def transcribeLogs(queryResult: EsSearchResult): ActivationLogs = { + val logs = queryResult.hits.hits.map(hit => { + val userLogEntry = hit.source.convertTo[UserLogEntry] + s"${userLogEntry.time} ${userLogEntry.stream}: ${userLogEntry.message.stripLineEnd}" + }) + + ActivationLogs(logs) + } + + private def extractRequiredHeaders(request: HttpRequest) = + request.headers.filter { + case header: HttpHeader if requiredHeaders.contains(header.lowercaseName) => true + case _ => false + }.toList + + private def generatePayload(activation: WhiskActivation) = { + val logQuery = s"_type: $logMessageField AND $activationIdField: ${activation.activationId}" + val queryString = EsQueryString(EsQueryValue(logQuery)) + val sort = Some(Array(EsQueryTimestamp(EsQueryOrder("asc")).toJson)) + + EsQuery(queryString.toJson, sort).toJson.asJsObject + } + + private def generatePath(user: Identity) = { + val date = LocalDate.now.format(DateTimeFormatter.ofPattern("yyyy.MM.dd")) + + Uri(s"/elasticsearch/logstash-${user.uuid.asString}-$date/_search") + } + + override def fetchLogs(user: Identity, activation: WhiskActivation, request: HttpRequest): Future[ActivationLogs] = { + val headers = extractRequiredHeaders(request) + + // Return logs from ElasticSearch, or return logs from activation if required headers are not present + if (headers.length == requiredHeaders.length) { + esClient.post(generatePath(user), headers, generatePayload(activation)).map { response => + response match { + case Right(queryResult) => + transcribeLogs(queryResult.convertTo[EsSearchResult]) + case Left(code) => + throw new RuntimeException(s"Status code '$code' was returned from log store") Review comment: Please use `flatMap` and then explicitly return `Future.failed` here instead of throwing an exception. It makes the intend more clear. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
