-
Notifications
You must be signed in to change notification settings - Fork 931
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.
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
Introduce ElasticSearch event logger for server events #5488
Open
bowenliang123
wants to merge
2
commits into
apache:master
Choose a base branch
from
bowenliang123:es-logger
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
149 changes: 149 additions & 0 deletions
149
...ts/src/main/scala/org/apache/kyuubi/events/handler/ElasticSearchLoggingEventHandler.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /* | ||
| * 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 org.apache.kyuubi.events.handler | ||
|
|
||
| import scala.concurrent.{ExecutionContext, ExecutionContextExecutor} | ||
| import scala.util.Failure | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper | ||
| import com.fasterxml.jackson.module.scala.DefaultScalaModule | ||
| import com.sksamuel.elastic4s.{ElasticClient, ElasticProperties} | ||
| import com.sksamuel.elastic4s.ElasticApi.indexInto | ||
| import com.sksamuel.elastic4s.ElasticDsl._ | ||
| import com.sksamuel.elastic4s.http.JavaClient | ||
| import com.sksamuel.elastic4s.requests.common.RefreshPolicy | ||
| import com.sksamuel.elastic4s.requests.mappings.MappingDefinition | ||
| import com.sksamuel.elastic4s.requests.mappings.dynamictemplate.DynamicMapping | ||
| import org.apache.commons.lang3.StringUtils | ||
| import org.apache.hadoop.util.Preconditions.checkArgument | ||
| import org.apache.http.auth.{AuthScope, UsernamePasswordCredentials} | ||
| import org.apache.http.impl.client.BasicCredentialsProvider | ||
| import org.apache.http.impl.nio.client.HttpAsyncClientBuilder | ||
| import org.elasticsearch.client.RestClientBuilder.HttpClientConfigCallback | ||
|
|
||
| import org.apache.kyuubi.{KyuubiException, Logging} | ||
| import org.apache.kyuubi.config.KyuubiConf | ||
| import org.apache.kyuubi.config.KyuubiConf._ | ||
| import org.apache.kyuubi.events.KyuubiEvent | ||
| import org.apache.kyuubi.events.handler.ElasticSearchLoggingEventHandler.getElasticClient | ||
| import org.apache.kyuubi.util.ThreadUtils | ||
|
|
||
| /** | ||
| * This event logger logs events to ElasticSearch. | ||
| */ | ||
| class ElasticSearchLoggingEventHandler( | ||
| indexId: String, | ||
| serverUrl: String, | ||
| username: Option[String] = None, | ||
| password: Option[String] = None, | ||
| kyuubiConf: KyuubiConf) extends EventHandler[KyuubiEvent] with Logging { | ||
|
|
||
| private val isAutoCreateIndex: Boolean = | ||
| kyuubiConf.get(SERVER_EVENT_ELASTICSEARCH_INDEX_AUTOCREATE_ENABLED) | ||
|
|
||
| private val esClient: ElasticClient = getElasticClient(serverUrl, username, password) | ||
|
|
||
| private val executorService = | ||
| ThreadUtils.newDaemonFixedThreadPool(1, "elasticsearch-event-handler-execution") | ||
| implicit private val executionContext: ExecutionContextExecutor = | ||
| ExecutionContext.fromExecutor(executorService) | ||
|
|
||
| private def checkIndexExisted: String => Boolean = (indexId: String) => { | ||
| checkArgument( | ||
| StringUtils.isNotBlank(indexId), | ||
| "index name must be configured for ElasticSearchEventHandler, please ensure %s is set", | ||
| SERVER_EVENT_ELASTICSEARCH_INDEX.key) | ||
| // check | ||
| esClient.execute { | ||
| indexExists(indexId) | ||
| }.await.result.isExists | ||
| } | ||
|
|
||
| private def checkAndEnsureIndex(indexId: String): Unit = { | ||
| if (!checkIndexExisted(indexId) && isAutoCreateIndex) { | ||
| esClient.execute { | ||
| createIndex(indexId) | ||
| .mapping(MappingDefinition(dynamic = Some(DynamicMapping.Dynamic))) | ||
| }.await | ||
| if (!checkIndexExisted(indexId)) { | ||
| throwExceptionIndexNotfound(indexId) | ||
| } | ||
| } else { | ||
| throwExceptionIndexNotfound(indexId) | ||
| } | ||
| } | ||
|
|
||
| checkAndEnsureIndex(indexId) | ||
|
|
||
| private val objectMapper = new ObjectMapper().registerModule(DefaultScalaModule) | ||
|
|
||
| override def apply(event: KyuubiEvent): Unit = { | ||
| val fields = { | ||
| objectMapper.readValue(event.toJson, classOf[Map[String, Any]]).map { | ||
| case (key: String, value: Any) => | ||
| val isNumber = (obj: Any) => { | ||
| obj.isInstanceOf[Byte] || obj.isInstanceOf[Short] || | ||
| obj.isInstanceOf[Int] || obj.isInstanceOf[Long] || | ||
| obj.isInstanceOf[Float] || obj.isInstanceOf[Double] | ||
| } | ||
| if (value.isInstanceOf[String] || isNumber(value)) { | ||
| (key, value) | ||
| } else { | ||
| (key, objectMapper.writeValueAsString(value)) | ||
| } | ||
| } | ||
| } | ||
| esClient.execute { | ||
bowenliang123 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| indexInto(indexId).fields(fields).refresh(RefreshPolicy.Immediate) | ||
| }.onComplete { | ||
| case Failure(f) => | ||
| error(s"Failed to send event in ElasticSearchLoggingEventHandler, ${f.getMessage}", f) | ||
| case _ => | ||
| } | ||
| } | ||
|
|
||
| override def close(): Unit = { | ||
| executorService.shutdown() | ||
| esClient.close() | ||
| } | ||
|
|
||
| private def throwExceptionIndexNotfound(indexId: String) = | ||
| throw new KyuubiException(s"the index '$indexId' is not found on ElasticSearch") | ||
| } | ||
|
|
||
| object ElasticSearchLoggingEventHandler { | ||
| def getElasticClient( | ||
| serverUrl: String, | ||
| user: Option[String], | ||
| password: Option[String]): ElasticClient = { | ||
| val props = ElasticProperties(serverUrl) | ||
| val configCallback: HttpClientConfigCallback = | ||
| (httpAsyncClientBuilder: HttpAsyncClientBuilder) => { | ||
| (user, password) match { | ||
| case (Some(userStr), Some(passwordStr)) => | ||
| val provider = new BasicCredentialsProvider | ||
| val credentials = new UsernamePasswordCredentials(userStr, passwordStr) | ||
| provider.setCredentials(AuthScope.ANY, credentials) | ||
| httpAsyncClientBuilder.setDefaultCredentialsProvider(provider) | ||
| case _ => httpAsyncClientBuilder | ||
| } | ||
| } | ||
| val javaClient = JavaClient.apply(props, configCallback) | ||
| ElasticClient(javaClient) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This does not seem to be a good solution that serializes the event into a json string and then deserializes it again into a map.
elastic4sprovides theindexInto(indexId).doc(XXX)method to directly index json string.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tried, but not working. Due to the nested fields that I have to serialize-deserialize-map again. Tried to implement a method for generating flat json, but not serializing properly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there any specific errors?