HPCC-30397 Review existing server spans to match expected conventions

Signed-off-by: Gavin Halliday <[email protected]>
hpcc-systems · Nov 20, 2023 · 61cc451 · 61cc451
1 parent 3630d8f
commit 61cc451
Show file tree

Hide file tree

Showing 11 changed files with 30 additions and 13 deletions.
diff --git a/ecl/eclagent/eclagent.cpp b/ecl/eclagent/eclagent.cpp
@@ -2131,7 +2131,8 @@ void EclAgent::runProcess(IEclProcess *process)
     allocatorMetaCache.setown(createRowAllocatorCache(this));
 
     Owned<IProperties> traceHeaders = extractTraceDebugOptions(queryWorkUnit());
-    Owned<ISpan> requestSpan = queryTraceManager().createServerSpan(queryWorkUnit()->queryWuid(), traceHeaders);
+    Owned<ISpan> requestSpan = queryTraceManager().createServerSpan("run_workunit", traceHeaders);
+    requestSpan->setSpanAttribute("hpcc.wuid", queryWorkUnit()->queryWuid());
     updateDummyContextLogger().setActiveSpan(requestSpan);
 
     // a component may specify an alternate name for the agent/workflow memory area,

diff --git a/esp/bindings/http/platform/httpservice.cpp b/esp/bindings/http/platform/httpservice.cpp
@@ -387,7 +387,7 @@ int CEspHttpServer::processRequest()
                 }
 
                 //Avoids unrestrictedSSType requests
-                m_request->startSpan();
+                m_request->startSpan(serviceName, methodName);
 
                 if(stricmp(method.str(), POST_METHOD)==0)
                     thebinding->handleHttpPost(m_request.get(), m_response.get());

diff --git a/esp/bindings/http/platform/httptransport.cpp b/esp/bindings/http/platform/httptransport.cpp
@@ -1915,11 +1915,16 @@ int CHttpRequest::receive(IMultiException *me)
     return 0;
 }
 
-void CHttpRequest::startSpan()
+void CHttpRequest::startSpan(const char * serviceName, const char * methodName)
 {
     //MORE: The previous code would be better off querying httpHeaders...
+    StringBuffer spanName;
+    spanName.append(serviceName);
+    if (!isEmptyString(methodName))
+        spanName.append("/").append(methodName);
+    spanName.toLowerCase();
     Owned<IProperties> httpHeaders = getHeadersAsProperties(m_headers);
-    Owned<ISpan> requestSpan = queryTraceManager().createServerSpan("HTTPRequest", httpHeaders, SpanFlags::EnsureGlobalId);
+    Owned<ISpan> requestSpan = queryTraceManager().createServerSpan(spanName, httpHeaders, SpanFlags::EnsureGlobalId);
     m_context->setActiveSpan(requestSpan);
 }
 

diff --git a/esp/bindings/http/platform/httptransport.ipp b/esp/bindings/http/platform/httptransport.ipp
@@ -369,7 +369,7 @@ public:
 
     virtual int receive(IMultiException *me);
 
-    void startSpan();
+    void startSpan(const char * serviceName, const char * methodName);
     void updateContext();
     void annotateSpan(const char * key, const char * value);
 

diff --git a/esp/services/ws_ecl/ws_ecl_service.cpp b/esp/services/ws_ecl/ws_ecl_service.cpp
@@ -2001,7 +2001,7 @@ int CWsEclBinding::submitWsEclWorkunit(IEspContext & context, WsEclWuInfo &wsinf
 
     Owned<ISpan> clientSpan;
     ISpan * activeSpan = context.queryActiveSpan();
-    clientSpan.setown(activeSpan->createClientSpan("wsecl/SubmitWorkunit"));
+    clientSpan.setown(activeSpan->createClientSpan("run_workunit"));
     Owned<IProperties> httpHeaders = ::getClientHeaders(clientSpan);
     recordTraceDebugOptions(workunit, httpHeaders);
 

diff --git a/esp/services/ws_workunits/ws_workunitsHelpers.cpp b/esp/services/ws_workunits/ws_workunitsHelpers.cpp
@@ -3769,6 +3769,11 @@ void WsWuHelpers::submitWsWorkunit(IEspContext& context, IConstWorkUnit* cw, con
         }
     }
 
+    ISpan * activeSpan = context.queryActiveSpan();
+    Owned<ISpan> clientSpan(activeSpan->createClientSpan("run_workunit"));
+    Owned<IProperties> httpHeaders = ::getClientHeaders(clientSpan);
+    recordTraceDebugOptions(wu, httpHeaders);
+
     if (resetWorkflow)
         wu->resetWorkflow();
     if (!compile)

diff --git a/roxie/ccd/ccdlistener.cpp b/roxie/ccd/ccdlistener.cpp
@@ -1179,7 +1179,8 @@ class RoxieWorkUnitWorker : public RoxieQueryWorker
         Owned<StringContextLogger> logctx = new StringContextLogger(wuid.get());
 
         Owned<IProperties> traceHeaders = extractTraceDebugOptions(wu);
-        Owned<ISpan> requestSpan = queryTraceManager().createServerSpan(wu->queryWuid(), traceHeaders);
+        Owned<ISpan> requestSpan = queryTraceManager().createServerSpan("run_workunit", traceHeaders);
+        requestSpan->setSpanAttribute("hpcc.wuid", wuid);
         logctx->setActiveSpan(requestSpan);
 
         Owned<IQueryFactory> queryFactory;
@@ -1438,7 +1439,7 @@ class RoxieProtocolMsgContext : implements IHpccProtocolMsgContext, public CInte
         return *cascade;
     }
 
-    virtual void startSpan(const char * id, const IProperties * headers) override
+    virtual void startSpan(const char * id, const char * queryName, const IProperties * headers) override
     {
         Linked<const IProperties> allHeaders = headers;
         SpanFlags flags = (ensureGlobalIdExists) ? SpanFlags::EnsureGlobalId : SpanFlags::None;
@@ -1455,7 +1456,8 @@ class RoxieProtocolMsgContext : implements IHpccProtocolMsgContext, public CInte
 
         ensureContextLogger();
 
-        Owned<ISpan> requestSpan = queryTraceManager().createServerSpan("request", allHeaders, flags);
+        const char * spanName = !isEmptyString(queryName) ? queryName : "run_query";
+        Owned<ISpan> requestSpan = queryTraceManager().createServerSpan(spanName, allHeaders, flags);
         logctx->setActiveSpan(requestSpan);
 
         const char * globalId = requestSpan->queryGlobalId();

diff --git a/roxie/ccd/ccdprotocol.cpp b/roxie/ccd/ccdprotocol.cpp
@@ -1891,7 +1891,7 @@ class RoxieSocketWorker : public ProtocolQueryWorker
                 uid = NULL;
                 sanitizeQuery(queryPT, queryName, sanitizedText, httpHelper, uid, isBlind, isDebug);
 
-                msgctx->startSpan(uid, httpHelper.queryRequestHeaders());
+                msgctx->startSpan(uid, queryName, httpHelper.queryRequestHeaders());
 
                 if (!uid)
                     uid = "-";

diff --git a/roxie/ccd/hpccprotocol.hpp b/roxie/ccd/hpccprotocol.hpp
@@ -41,7 +41,7 @@ interface IHpccProtocolMsgContext : extends IInterface
     virtual bool getIntercept() = 0;
     virtual void outputLogXML(IXmlStreamFlusher &out) = 0;
     virtual void writeLogXML(IXmlWriter &writer) = 0;
-    virtual void startSpan(const char * uid, const IProperties * headers) = 0;
+    virtual void startSpan(const char * uid, const char * queryName, const IProperties * headers) = 0;
 };
 
 interface IHpccProtocolResultsWriter : extends IInterface

diff --git a/thorlcr/graph/thgraphmaster.cpp b/thorlcr/graph/thgraphmaster.cpp
@@ -1485,7 +1485,9 @@ CJobMaster::CJobMaster(IConstWorkUnit &_workunit, const char *graphName, ILoaded
     init();
 
     Owned<IProperties> traceHeaders = extractTraceDebugOptions(workunit);
-    Owned<ISpan> requestSpan = queryTraceManager().createServerSpan(workunit->queryWuid(), traceHeaders);
+    Owned<ISpan> requestSpan = queryTraceManager().createServerSpan("run_graph", traceHeaders);
+    requestSpan->setSpanAttribute("hpcc.wuid", workunit->queryWuid());
+    requestSpan->setSpanAttribute("hpcc.graph", graphName);
     logctx->setActiveSpan(requestSpan);
 
     resumed = WUActionResume == workunit->getAction();

diff --git a/thorlcr/graph/thgraphslave.cpp b/thorlcr/graph/thgraphslave.cpp
@@ -1680,7 +1680,9 @@ CJobSlave::CJobSlave(ISlaveWatchdog *_watchdog, IPropertyTree *_workUnitInfo, co
     init();
 
     Owned<IProperties> traceHeaders = deserializeTraceDebugOptions(workUnitInfo->queryPropTree("Debug"));
-    Owned<ISpan> requestSpan = queryTraceManager().createServerSpan(wuid, traceHeaders);
+    Owned<ISpan> requestSpan = queryTraceManager().createServerSpan("run_graph", traceHeaders);
+    requestSpan->setSpanAttribute("hpcc.wuid", wuid);
+    requestSpan->setSpanAttribute("hpcc.graph", graphName);
     logctx->setActiveSpan(requestSpan);
 
     oldNodeCacheMem = 0;