1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.api.technical
21 
22 import cats.implicits._
23 import grizzled.slf4j.Logging
24 import kamon.instrumentation.http.{HttpMessage, HttpOperationNameGenerator}
25 import kamon.Kamon
26 import kamon.trace.Span
27 import org.make.api.technical.tracing.Tracing
28 import com.typesafe.config.ConfigFactory
29 
30 class MakeClientOperationNameGenerator extends HttpOperationNameGenerator with Logging {
31 
32   logger.info("Creating the Make name generator for akka-http")
33 
34   override def name(request: HttpMessage.Request): Option[String] = {
35     val spanName = Kamon.currentSpan().operationName()
36     val operationName =
37       if (spanName === Span.Empty.operationName() || Tracing.entrypoint.contains(spanName))
38         createOperationNameFromRequest(request)
39       else
40         spanName
41     Some(operationName)
42   }
43 
44   private val IgnoredPorts = Set(80, 443, 0)
45   private def createOperationNameFromRequest(request: HttpMessage.Request): String =
46     ElasticsearchSpanGeneration.generate(request).getOrElse {
47       val portString =
48         if (IgnoredPorts.contains(request.port)) ""
49         else s":${request.port}"
50       s"${request.host}$portString${request.path}"
51     }
52 }
53 
54 object ElasticsearchSpanGeneration {
55 
56   private val esConfig =
57     ConfigFactory
58       .load("default-application.conf")
59       .getConfig("make-api.elasticSearch")
60 
61   private val connectionString = esConfig.getString("connection-string")
62 
63   private val ideaAliasName = esConfig.getString("idea-alias-name")
64   private val proposalAliasName = esConfig.getString("proposal-alias-name")
65   private val organisationAliasName = esConfig.getString("organisation-alias-name")
66   private val operationOfQuestionAliasName = esConfig.getString("operation-of-question-alias-name")
67   private val postAliasName = esConfig.getString("post-alias-name")
68 
69   private val ESAliasesNames =
70     List(ideaAliasName, proposalAliasName, organisationAliasName, operationOfQuestionAliasName, postAliasName)
71 
72   def generate(request: HttpMessage.Request): Option[String] =
73     Option.when(connectionString.contains(request.host)) {
74       // ES query parameters are part of its path. We need to clean it up by only keeping the relevant
75       // part so as not to blow up the granularity of operation names.
76       "elasticsearch" ++ ESAliasesNames.find(request.path.contains).fold("")('-' +: _)
77     }
78 }