[Core] - Logging add correlation id to requests going to foxx api

[JoshuaSBrown]

The following needs to be added to dbGet, dbPost, and dbGetRaw

struct curl_slist* headers = nullptr;

// safe: curl_slist_append copies the string internally
headers = curl_slist_append(headers, (std::string("x-correlation-id: ") + log_context.correlation_id).c_str());

// attach headers to the CURL handle
curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

Then after the curl perform call

curl_slist_free_all(headers);

There are several functions where you will need to generate the correlation-id-x from scratch in the core server.

i.e.

in CoreServer

db.notePurge is called in dbMaintenance.
serverPing is called in waitForDB
db.metricsPurge in metricsThread
db.metricsUpdateMsgCounts in metricsThread

in TaskMgr

db.taskLoadReady in initialize
db.taskPurge in purgeTaskHistory

in AuthMap

db.uidByPubKey in hasKey
db.uidByPubKey in getUIDSafe

Can generate a UUID from scratch in C++ using boost.

#include <boost/uuid/uuid.hpp>              // uuid class
#include <boost/uuid/uuid_generators.hpp>   // generators
#include <boost/uuid/uuid_io.hpp>           // streaming operators
#include <iostream>

int main() {
    // Create a random UUID generator
    boost::uuids::random_generator generator;

    // Generate a UUIDv4
    boost::uuids::uuid uuid = generator();

    // Print it
    std::cout << "UUIDv4: " << uuid << std::endl;

    return 0;
}

[JoshuaSBrown]

Flow 1.

common source/operators/AuthenticationOperator.cpp

• Correlation id needs to come from the Message and passed to hasKey

void AuthenticationOperator::execute(IMessage &message) {

    :
    
    if (m_authentication_manager->hasKey(key)) {

    :

This requires making changes in
common include/common/IAuthenticationManager.hpp : hasKey
core/server/AuthenticationManager.hpp : hasKey
core/server/AuthenticationManager.cpp : hasKey
core/server/AuthMap.hpp : hasKey
core/server/AuthMap.cpp : hasKey
core/server/DatabaseAPI.hpp : uidByPubKey
core/server/DatabaseAPI.cpp : uidByPubKey

Flow 2

Same as flow 1 and flow 3

common/source/operators AuthenticationOperator.cpp
core/server/AuthenticationManager.cpp : incrementKeyAccessCounter -
core/server/AuthMap.hpp : hasKey
core/server/AuthMap.cpp : hasKey
core/server/DatabaseAPI.hpp : uidByPubKey
core/server/DatabaseAPI.cpp : uidByPubKey

Flow 3

Here the correlation id should be extracted from the message in the AuthenticationOperator and passed up the chain to the getUID method etc... this is the same as Flow 1

common/source/operators AuthenticationOperator.cpp
core/server/AuthenticationManager.cpp : getUID
core/server/AuthMap.hpp : hasKey
core/server/AuthMap.cpp : hasKey
core/server/DatabaseAPI.hpp : uidByPubKey
core/server/DatabaseAPI.cpp : uidByPubKey

Flow 4

In this flow the authentication manager initializes the request, from the condition the correlation id should be generated in the condition, each correlation id should be unique for each purge request. So it should be created in the condition enforce method, and passed to the getUID method

  void Promote::enforce(AuthMap &auth_map, const std::string &public_key) {
    if (auth_map.hasKeyType(m_promote_from, public_key)) {
      size_t access_count = auth_map.getAccessCount(m_promote_from, public_key);
      if (access_count >= m_transient_to_session_count_threshold) {
        // Convert transient key to session key if has been accessed more than the
        // threshold
        std::string uid = auth_map.getUID(m_promote_from, public_key);
        auth_map.addKey(m_promote_to, public_key, uid);
      }
      // Remove expired short lived transient key
      auth_map.removeKey(m_promote_from, public_key);
      // Set the access counter so that it doesn't get prematurely removed
      auth_map.setAccessCount(m_promote_to, public_key, access_count);
    }
  }

core/server AuthenticationManager.cpp : purge(const PublicKeyType pub_key_type)
core/server/Condition.cpp - Promote : enforce
core/server/AuthMap.hpp : getUID
core/server/AuthMap.cpp : getUID
core/server/AuthMap.hpp : getUIDSafe
core/server/AuthMap.cpp : getUIDSafe
core/server/DatabaseAPI.hpp : uidByPubKey
core/server/DatabaseAPI.cpp : uidByPubKey