HPCC-30403 Provid ECL based API for Tracing

- Declares several ecl calls to logging library - Defines getTraceSpanHeader, getTraceStateHeader - Defines getTraceID, getSpanID, setSpanAttribute Signed-off-by: Rodrigo Pastrana <[email protected]>
hpcc-systems · Nov 21, 2023 · e706bab · e706bab
1 parent cef0bf9
commit e706bab
Show file tree

Hide file tree

Showing 11 changed files with 155 additions and 1 deletion.
diff --git a/common/thorhelper/thorcommon.hpp b/common/thorhelper/thorcommon.hpp
@@ -725,6 +725,14 @@ class CStatsContextLogger : public CSimpleInterfaceOf<IContextLogger>
     {
         return ::getClientHeaders(activeSpan);
     }
+    virtual IProperties * getSpanContext() const override
+    {
+        return ::getSpanContext(activeSpan);
+    }
+    virtual void setSpanAttribute(const char *name, const char *value) const override
+    {
+        return ::setSpanAttribute(activeSpan, name, value);
+    }
     virtual const char *queryGlobalId() const override
     {
         return activeSpan->queryGlobalId();

diff --git a/ecllibrary/std/system/Log.ecl b/ecllibrary/std/system/Log.ecl
@@ -89,4 +89,35 @@ EXPORT generateGloballyUniqueId() := lib_logging.Logging.generateGloballyUniqueI
 
 EXPORT getElapsedMs() := lib_logging.Logging.getElapsedMs();
 
+/*
+ * Gets the active span's traceID.
+ *
+ * Returns the the unique Id.
+ */
+EXPORT getTraceID() := lib_logging.Logging.getTraceID();
+/*
+ * Gets the active spanID.
+ *
+ * Returns the the unique Id.
+ */
+EXPORT getSpanID() := lib_logging.Logging.getSpanID();
+/*
+ * Gets OpenTelemetry formatted trace span header.
+ * Should be provided to remote services for trace propagation as 'traceparent'.
+ * 
+  * Returns the the unique Id.
+ */
+EXPORT getTraceSpanHeader() := lib_logging.Logging.getTraceSpanHeader();
+/*
+ * Gets OpenTelemetry formatted trace state header.
+ * Should be provided to remote services for trace propagation as 'tracestate'.
+ * 
+  * Returns the the unique Id.
+ */
+EXPORT getTraceStateHeader() := lib_logging.Logging.getTraceStateHeader();
+/*
+ * Adds the name/value pair to the active span as an attribute.
+ */
+EXPORT setSpanAttribute(string name, string value) := lib_logging.Logging.setSpanAttribute(name, value);
+
 END;
diff --git a/plugins/logging/logging.cpp b/plugins/logging/logging.cpp
@@ -22,7 +22,7 @@
 #include "logging.hpp"
 #include "jlog.hpp"
 
-#define LOGGING_VERSION "LOGGING 1.0.1"
+#define LOGGING_VERSION "LOGGING 1.0.2"
 static const char * compatibleVersions[] = {
     "LOGGING 1.0.0 [66aec3fb4911ceda247c99d6a2a5944c]", // linux version
     LOGGING_VERSION,
@@ -42,6 +42,11 @@ static const char * EclDefinition =
 "  varstring getCallerId() : c,context,entrypoint='logGetCallerId'; \n"
 "  varstring generateGloballyUniqueId() : c,entrypoint='logGenerateGloballyUniqueId'; \n"
 "  unsigned4 getElapsedMs() : c,context,entrypoint='logGetElapsedMs'; \n"
+"  varstring getTraceSpanHeader() : c,context,entrypoint='getTraceSpanHeader'; \n"
+"  varstring getTraceStateHeader() : c,context,entrypoint='getTraceStateHeader'; \n"
+"  varstring getTraceID() : c,context,entrypoint='getTraceID'; \n"
+"  varstring getSpanID() : c,context,entrypoint='getSpanID'; \n"
+"  setSpanAttribute(const string name, const string value) : c,context,action,entrypoint='setSpanAttribute'; \n"
 "END;";
 
 LOGGING_API bool getECLPluginDefinition(ECLPluginDefinitionBlock *pb) 
@@ -117,3 +122,52 @@ LOGGING_API unsigned int LOGGING_CALL logGetElapsedMs(ICodeContext *ctx)
 {
     return ctx->getElapsedMs();
 }
+
+LOGGING_API char * LOGGING_CALL getTraceID(ICodeContext *ctx)
+{
+    StringBuffer ret;
+    Owned<IProperties> httpHeaders = ctx->queryContextLogger().getSpanContext();
+    if (httpHeaders)
+        ret.set(httpHeaders->queryProp("traceID"));
+
+    return ret.detach();
+}
+
+LOGGING_API char * LOGGING_CALL getSpanID(ICodeContext *ctx)
+{
+    StringBuffer ret;
+    Owned<IProperties> httpHeaders = ctx->queryContextLogger().getSpanContext();
+    if (httpHeaders)
+        ret.set(httpHeaders->queryProp("spanID"));
+
+    return ret.detach();
+}
+
+LOGGING_API char * LOGGING_CALL getTraceSpanHeader(ICodeContext *ctx)
+{
+    StringBuffer ret;
+    Owned<IProperties> httpHeaders = ctx->queryContextLogger().getClientHeaders();
+    if (httpHeaders)
+        ret.set(httpHeaders->queryProp("traceparent"));
+
+    return ret.detach();
+}
+
+LOGGING_API char * LOGGING_CALL getTraceStateHeader(ICodeContext *ctx)
+{
+    StringBuffer ret;
+    Owned<IProperties> httpHeaders = ctx->queryContextLogger().getClientHeaders();
+    if (httpHeaders)
+        ret.set(httpHeaders->queryProp("tracestate"));
+
+    return ret.detach();
+}
+
+LOGGING_API void LOGGING_CALL setSpanAttribute(ICodeContext *ctx,
+ unsigned nameLen, const char * name, unsigned valueLen, const char * value)
+{
+    StringBuffer attName(nameLen, name);
+    StringBuffer attVal(valueLen, value);
+
+    ctx->queryContextLogger().setSpanAttribute(attName.str(), attVal.str());
+}
diff --git a/plugins/logging/logging.hpp b/plugins/logging/logging.hpp
@@ -42,6 +42,11 @@ LOGGING_API char * LOGGING_CALL logGetCallerId(ICodeContext *ctx);
 LOGGING_API char * LOGGING_CALL logGetLocalId(ICodeContext *ctx);
 LOGGING_API char * LOGGING_CALL logGenerateGloballyUniqueId();
 LOGGING_API unsigned int LOGGING_CALL logGetElapsedMs(ICodeContext *ctx);
+LOGGING_API char * LOGGING_CALL getTraceSpanHeader(ICodeContext *ctx);
+LOGGING_API char * LOGGING_CALL getTraceStateHeader(ICodeContext *ctx);
+LOGGING_API char * LOGGING_CALL getTraceID(ICodeContext *ctx);
+LOGGING_API char * LOGGING_CALL getSpanID(ICodeContext *ctx);
+LOGGING_API void LOGGING_CALL setSpanAttribute(ICodeContext *ctx, unsigned nameLen, const char * name, unsigned valueLen, const char * value);
 
 }
 

diff --git a/roxie/ccd/ccd.hpp b/roxie/ccd/ccd.hpp
@@ -750,6 +750,14 @@ class ContextLogger : implements IRoxieContextLogger, public CInterface
     {
         return ::getClientHeaders(activeSpan);
     }
+    virtual IProperties * getSpanContext() const override
+    {
+        return ::getSpanContext(activeSpan);
+    }
+    virtual void setSpanAttribute(const char *name, const char *value) const override
+    {
+        return ::setSpanAttribute(activeSpan, name, value);
+    }
     virtual const char *queryGlobalId() const override
     {
         return activeSpan->queryGlobalId();

diff --git a/roxie/ccd/ccdcontext.cpp b/roxie/ccd/ccdcontext.cpp
@@ -1390,6 +1390,14 @@ class CRoxieContextBase : implements IRoxieAgentContext, implements ICodeContext
     {
         return logctx.getClientHeaders();
     }
+    virtual IProperties * getSpanContext() const override
+    {
+        return logctx.getSpanContext();
+    }
+    virtual void setSpanAttribute(const char *name, const char *value) const override
+    {
+        return logctx.setSpanAttribute(name, value);
+    }
     virtual const char *queryGlobalId() const override
     {
         return logctx.queryGlobalId();

diff --git a/roxie/ccd/ccdserver.cpp b/roxie/ccd/ccdserver.cpp
@@ -284,6 +284,14 @@ class IndirectAgentContext : implements IRoxieAgentContext, public CInterface
     {
         return ctx->getClientHeaders();
     }
+    virtual IProperties * getSpanContext() const override
+    {
+        return ctx->getSpanContext();
+    }
+    virtual void setSpanAttribute(const char *name, const char *value) const override
+    {
+        return ctx->setSpanAttribute(name, value);
+    }
     virtual const char *queryGlobalId() const
     {
         return ctx->queryGlobalId();
@@ -1362,6 +1370,14 @@ class CRoxieServerActivity : implements CInterfaceOf<IRoxieServerActivity>, impl
             return ctx->getClientHeaders();
         return nullptr;
     }
+    virtual IProperties * getSpanContext() const override
+    {
+        return ctx->getSpanContext();
+    }
+    virtual void setSpanAttribute(const char *name, const char *value) const override
+    {
+        return ctx->setSpanAttribute(name, value);
+    }
     virtual const char *queryGlobalId() const override
     {
         return ctx ? ctx->queryGlobalId() : nullptr;

diff --git a/system/jlib/jlog.cpp b/system/jlib/jlog.cpp
@@ -2876,6 +2876,14 @@ class DummyLogCtx : implements IContextLogger
     {
         return ::getClientHeaders(activeSpan);
     }
+    virtual IProperties * getSpanContext() const override
+    {
+        return ::getSpanContext(activeSpan);
+    }
+    virtual void setSpanAttribute(const char *name, const char *value) const override
+    {
+        return ::setSpanAttribute(activeSpan, name, value);
+    }
     virtual const char *queryGlobalId() const override
     {
         return activeSpan->queryGlobalId();

diff --git a/system/jlib/jlog.hpp b/system/jlib/jlog.hpp
@@ -1272,7 +1272,9 @@ interface jlib_decl IContextLogger : extends IInterface
     virtual const char *queryCallerId() const = 0;
     virtual const CRuntimeStatisticCollection & queryStats() const = 0;
     virtual void setActiveSpan(ISpan * span) = 0;
+    virtual IProperties * getSpanContext() const = 0;
     virtual IProperties * getClientHeaders() const = 0;
+    virtual void setSpanAttribute(const char *name, const char *value) const = 0;
     virtual void recordStatistics(IStatisticGatherer &progress) const = 0;
     virtual const LogMsgJobInfo & queryJob() const { return unknownJob; }
 };

diff --git a/system/jlib/jtrace.cpp b/system/jlib/jtrace.cpp
@@ -730,6 +730,18 @@ IProperties * getClientHeaders(const ISpan * span)
     return headers.getClear();
 }
 
+void setSpanAttribute(ISpan * span, const char * name, const char * val)
+{
+    span->setSpanAttribute(name, val);
+}
+
+IProperties * getSpanContext(const ISpan * span)
+{
+    Owned<IProperties> headers = createProperties(true);
+    span->getSpanContext(headers, false);
+    return headers.getClear();
+}
+
 //---------------------------------------------------------------------------------------------------------------------
 
 class CTraceManager : implements ITraceManager, public CInterface

diff --git a/system/jlib/jtrace.hpp b/system/jlib/jtrace.hpp
@@ -55,6 +55,8 @@ interface ISpan : extends IInterface
 };
 
 extern jlib_decl IProperties * getClientHeaders(const ISpan * span);
+extern jlib_decl IProperties * getSpanContext(const ISpan * span);
+extern jlib_decl void setSpanAttribute(ISpan * span, const char * name, const char * val);
 
 interface ITraceManager : extends IInterface
 {