tysonnorris commented on a change in pull request #2957: splunk logstore URL: https://github.com/apache/incubator-openwhisk/pull/2957#discussion_r167666011
########## File path: common/scala/src/main/scala/whisk/core/containerpool/logging/SplunkLogStore.scala ########## @@ -0,0 +1,156 @@ +/* + * 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 akka.actor.ActorSystem +import akka.http.scaladsl.Http +import java.time.ZoneId +import java.time.format.DateTimeFormatter + +import akka.http.scaladsl.client.RequestBuilding.Post +import akka.http.scaladsl.model.FormData +import akka.http.scaladsl.model.HttpRequest +import akka.http.scaladsl.model.HttpResponse +import akka.http.scaladsl.model.headers.Authorization +import akka.http.scaladsl.model.headers.BasicHttpCredentials +import akka.http.scaladsl.unmarshalling.Unmarshal +import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport._ +import akka.stream.ActorMaterializer +import akka.stream.OverflowStrategy +import akka.stream.QueueOfferResult +import akka.stream.scaladsl.Flow +import akka.stream.scaladsl.Keep +import akka.stream.scaladsl.Sink +import akka.stream.scaladsl.Source +import com.typesafe.sslconfig.akka.AkkaSSLConfig +import scala.concurrent.Future +import scala.concurrent.Promise +import scala.util.Failure +import scala.util.Success +import scala.util.Try +import spray.json.DefaultJsonProtocol._ +import spray.json.JsArray +import spray.json._ +import whisk.core.entity.ActivationLogs +import whisk.core.entity.WhiskActivation +import pureconfig._ + +case class SplunkLogStoreConfig(host: String, + port: Int, + username: String, + password: String, + index: String, + logMessageField: String, + activationIdField: String, + disableSNI: Boolean) + +/** + * A Splunk based impl of LogDriverLogStore. Logs are routed to splunk via docker log driver, and retrieved via Splunk REST API + * + * @param actorSystem + * @param httpFlow Optional Flow to use for HttpRequest handling (to enable stream based tests) + */ +class SplunkLogStore( + actorSystem: ActorSystem, + httpFlow: Option[Flow[(HttpRequest, Promise[HttpResponse]), (Try[HttpResponse], Promise[HttpResponse]), Any]] = None, + splunkConfig: SplunkLogStoreConfig = loadConfigOrThrow[SplunkLogStoreConfig]("whisk.logstore.splunk")) + extends LogDriverLogStore(actorSystem) { + implicit val as = actorSystem + implicit val ec = as.dispatcher + implicit val materializer = ActorMaterializer() + + private val splunkApi = "/services/search/jobs" //see http://docs.splunk.com/Documentation/Splunk/6.6.3/RESTREF/RESTsearch#search.2Fjobs + + val log = actorSystem.log + val maxPendingRequests = 500 + + val defaultHttpFlow = Http().cachedHostConnectionPoolHttps[Promise[HttpResponse]]( + host = splunkConfig.host, + port = splunkConfig.port, + connectionContext = + if (splunkConfig.disableSNI) + Http().createClientHttpsContext(AkkaSSLConfig().mapSettings(s => s.withLoose(s.loose.withDisableSNI(true)))) + else Http().defaultClientHttpsContext) + + override def fetchLogs(activation: WhiskActivation): Future[ActivationLogs] = { + + //example curl request: + // curl -u username:password -k https://splunkhost:port/services/search/jobs -d exec_mode=oneshot -d output_mode=json -d "search=search index=\"someindex\" | spath=activation_id | search activation_id=a930e5ae4ad4455c8f2505d665aad282 | table log_message" -d "earliest_time=2017-08-29T12:00:00" -d "latest_time=2017-10-29T12:00:00" + //example response: + // {"preview":false,"init_offset":0,"messages":[],"fields":[{"name":"log_message"}],"results":[{"log_message":"some log message"}], "highlighted":{}} + val search = + s"""search index="${splunkConfig.index}"| spath ${splunkConfig.activationIdField}| search ${splunkConfig.activationIdField}=${activation.activationId.toString}| table ${splunkConfig.logMessageField}""" + + val formatter = DateTimeFormatter.ofPattern("YYYY-MM-dd'T'hh:mm:ss").withZone(ZoneId.of("UTC")) + val entity = FormData( + Map( + "exec_mode" -> "oneshot", + "search" -> search, + "output_mode" -> "json", + "earliest_time" -> formatter.format(activation.start), + "latest_time" -> formatter + .format(activation.end.plusSeconds(5)))).toEntity //add 5s to avoid a timerange of 0 on short-lived activations + + log.debug("sending request") + queueRequest( + Post(splunkApi) + .withEntity(entity) + .withHeaders(List(Authorization(BasicHttpCredentials(splunkConfig.username, splunkConfig.password))))) + .flatMap(response => { + log.debug(s"splunk API response ${response}") + Unmarshal(response.entity) + .to[JsObject] + .map(r => { + ActivationLogs( + r.fields("results") + .convertTo[JsArray] + .elements + .map(_.asJsObject.fields(splunkConfig.logMessageField).convertTo[String])) + }) Review comment: I like it! ---------------------------------------------------------------- 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: us...@infra.apache.org With regards, Apache Git Services
