onesdk_agent.h

Go to the documentation of this file.

/*
    Copyright 2017-2019 Dynatrace LLC

    Licensed 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.
*/

#ifndef ONESDK_AGENT_H_INCLUDED
#define ONESDK_AGENT_H_INCLUDED

/*========================================================================================================================================*/

#include "onesdk/onesdk_common.h" /* IWYU pragma: export */
#include "onesdk/onesdk_string.h"

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_xchar_t const*) onesdk_agent_get_version_string(void);

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_int32_t) onesdk_agent_get_current_state(void);

ONESDK_DECLARE_FUNCTION(void) onesdk_agent_set_logging_callback(onesdk_agent_logging_callback_t* agent_logging_callback);

ONESDK_DECLARE_FUNCTION(onesdk_result_t) onesdk_agent_set_warning_callback(onesdk_agent_logging_callback_t* agent_logging_callback);

ONESDK_DECLARE_FUNCTION(onesdk_result_t) onesdk_agent_set_verbose_callback(onesdk_agent_logging_callback_t* agent_logging_callback);



ONESDK_DECLARE_FUNCTION(onesdk_int32_t) onesdk_agent_get_fork_state(void);

/*========================================================================================================================================*/

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(void) onesdk_tracer_start(onesdk_tracer_handle_t tracer_handle);

ONESDK_DECLARE_FUNCTION(void) onesdk_tracer_end(onesdk_tracer_handle_t tracer_handle);

ONESDK_DECLARE_FUNCTION(void) onesdk_tracer_error_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* error_class, onesdk_string_t const* error_message);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_tracer_error(onesdk_tracer_handle_t tracer_handle, onesdk_string_t error_class, onesdk_string_t error_message) {
    onesdk_tracer_error_p(tracer_handle, &error_class, &error_message);
}

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_size_t) onesdk_tracer_get_outgoing_dynatrace_string_tag(onesdk_tracer_handle_t tracer_handle, char* buffer, onesdk_size_t buffer_size, onesdk_size_t* required_buffer_size);

ONESDK_DECLARE_FUNCTION(onesdk_size_t) onesdk_tracer_get_outgoing_dynatrace_byte_tag(onesdk_tracer_handle_t tracer_handle, unsigned char* buffer, onesdk_size_t buffer_size, onesdk_size_t* required_buffer_size);

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(void) onesdk_tracer_set_incoming_dynatrace_string_tag_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* string_tag);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_tracer_set_incoming_dynatrace_string_tag(onesdk_tracer_handle_t tracer_handle, onesdk_string_t string_tag) {
    onesdk_tracer_set_incoming_dynatrace_string_tag_p(tracer_handle, &string_tag);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_tracer_set_incoming_dynatrace_byte_tag(onesdk_tracer_handle_t tracer_handle, unsigned char const* byte_tag, onesdk_size_t byte_tag_size);

/*========================================================================================================================================*/

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(void) onesdk_customrequestattribute_add_integers_p(onesdk_string_t const* keys, onesdk_int64_t const* values, onesdk_size_t count);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_customrequestattribute_add_integer(onesdk_string_t key, onesdk_int64_t value) {
    onesdk_customrequestattribute_add_integers_p(&key, &value, 1);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_customrequestattribute_add_floats_p(onesdk_string_t const* keys, double const* values, onesdk_size_t count);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_customrequestattribute_add_float(onesdk_string_t key, double value) {
    onesdk_customrequestattribute_add_floats_p(&key, &value, 1);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_customrequestattribute_add_strings_p(onesdk_string_t const* keys, onesdk_string_t const* values, onesdk_size_t count);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_customrequestattribute_add_string(onesdk_string_t key, onesdk_string_t value) {
    onesdk_customrequestattribute_add_strings_p(&key, &value, 1);
}

/*========================================================================================================================================*/

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_size_t) onesdk_inprocesslink_create(unsigned char* buffer, onesdk_size_t buffer_size, onesdk_size_t* required_buffer_size);

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_inprocesslinktracer_create(unsigned char const* in_process_link, onesdk_size_t in_process_link_size);

/*========================================================================================================================================*/

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_outgoingremotecalltracer_create_p(onesdk_string_t const* service_method, onesdk_string_t const* service_name, onesdk_string_t const* service_endpoint, onesdk_int32_t channel_type, onesdk_string_t const* channel_endpoint);

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_tracer_handle_t) onesdk_outgoingremotecalltracer_create(onesdk_string_t service_method, onesdk_string_t service_name, onesdk_string_t service_endpoint, onesdk_int32_t channel_type, onesdk_string_t channel_endpoint) {
    return onesdk_outgoingremotecalltracer_create_p(&service_method, &service_name, &service_endpoint, channel_type, &channel_endpoint);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_outgoingremotecalltracer_set_protocol_name_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* protocol_name);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_outgoingremotecalltracer_set_protocol_name(onesdk_tracer_handle_t tracer_handle, onesdk_string_t protocol_name) {
    onesdk_outgoingremotecalltracer_set_protocol_name_p(tracer_handle, &protocol_name);
}

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_incomingremotecalltracer_create_p(onesdk_string_t const* service_method, onesdk_string_t const* service_name, onesdk_string_t const* service_endpoint);

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_tracer_handle_t) onesdk_incomingremotecalltracer_create(onesdk_string_t service_method, onesdk_string_t service_name, onesdk_string_t service_endpoint) {
    return onesdk_incomingremotecalltracer_create_p(&service_method, &service_name, &service_endpoint);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_incomingremotecalltracer_set_protocol_name_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* protocol_name);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_incomingremotecalltracer_set_protocol_name(onesdk_tracer_handle_t tracer_handle, onesdk_string_t protocol_name) {
    onesdk_incomingremotecalltracer_set_protocol_name_p(tracer_handle, &protocol_name);
}

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_databaseinfo_handle_t) onesdk_databaseinfo_create_p(onesdk_string_t const* name, onesdk_string_t const* vendor, onesdk_int32_t channel_type, onesdk_string_t const* channel_endpoint);

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_databaseinfo_handle_t) onesdk_databaseinfo_create(onesdk_string_t name, onesdk_string_t vendor, onesdk_int32_t channel_type, onesdk_string_t channel_endpoint) {
    return onesdk_databaseinfo_create_p(&name, &vendor, channel_type, &channel_endpoint);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_databaseinfo_delete(onesdk_databaseinfo_handle_t databaseinfo_handle);

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_databaserequesttracer_create_sql_p(onesdk_databaseinfo_handle_t databaseinfo_handle, onesdk_string_t const* statement);

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_tracer_handle_t) onesdk_databaserequesttracer_create_sql(onesdk_databaseinfo_handle_t databaseinfo_handle, onesdk_string_t statement) {
    return onesdk_databaserequesttracer_create_sql_p(databaseinfo_handle, &statement);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_databaserequesttracer_set_returned_row_count(onesdk_tracer_handle_t tracer_handle, onesdk_int32_t returned_row_count);

ONESDK_DECLARE_FUNCTION(void) onesdk_databaserequesttracer_set_round_trip_count(onesdk_tracer_handle_t tracer_handle, onesdk_int32_t round_trip_count);

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_webapplicationinfo_handle_t) onesdk_webapplicationinfo_create_p(onesdk_string_t const* web_server_name, onesdk_string_t const* application_id, onesdk_string_t const* context_root);

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_webapplicationinfo_handle_t) onesdk_webapplicationinfo_create(onesdk_string_t web_server_name, onesdk_string_t application_id, onesdk_string_t context_root) {
    return onesdk_webapplicationinfo_create_p(&web_server_name, &application_id, &context_root);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_webapplicationinfo_delete(onesdk_webapplicationinfo_handle_t webapplicationinfo_handle);

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_incomingwebrequesttracer_create_p(onesdk_webapplicationinfo_handle_t webapplicationinfo_handle, onesdk_string_t const* url, onesdk_string_t const* method);

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_tracer_handle_t) onesdk_incomingwebrequesttracer_create(onesdk_webapplicationinfo_handle_t webapplicationinfo_handle, onesdk_string_t url, onesdk_string_t method) {
    return onesdk_incomingwebrequesttracer_create_p(webapplicationinfo_handle, &url, &method);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_incomingwebrequesttracer_set_remote_address_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* remote_address);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_incomingwebrequesttracer_set_remote_address(onesdk_tracer_handle_t tracer_handle, onesdk_string_t remote_address) {
    onesdk_incomingwebrequesttracer_set_remote_address_p(tracer_handle, &remote_address);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_incomingwebrequesttracer_add_request_headers_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* names, onesdk_string_t const* values, onesdk_size_t count);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_incomingwebrequesttracer_add_request_header(onesdk_tracer_handle_t tracer_handle, onesdk_string_t name, onesdk_string_t value) {
    onesdk_incomingwebrequesttracer_add_request_headers_p(tracer_handle, &name, &value, 1);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_incomingwebrequesttracer_add_parameters_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* names, onesdk_string_t const* values, onesdk_size_t count);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_incomingwebrequesttracer_add_parameter(onesdk_tracer_handle_t tracer_handle, onesdk_string_t name, onesdk_string_t value) {
    onesdk_incomingwebrequesttracer_add_parameters_p(tracer_handle, &name, &value, 1);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_incomingwebrequesttracer_add_response_headers_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* names, onesdk_string_t const* values, onesdk_size_t count);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_incomingwebrequesttracer_add_response_header(onesdk_tracer_handle_t tracer_handle, onesdk_string_t name, onesdk_string_t value) {
    onesdk_incomingwebrequesttracer_add_response_headers_p(tracer_handle, &name, &value, 1);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_incomingwebrequesttracer_set_status_code(onesdk_tracer_handle_t tracer_handle, onesdk_int32_t status_code);

/*========================================================================================================================================*/

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_outgoingwebrequesttracer_create_p(onesdk_string_t const* url, onesdk_string_t const* method);

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_tracer_handle_t) onesdk_outgoingwebrequesttracer_create(onesdk_string_t url, onesdk_string_t method) {
    return onesdk_outgoingwebrequesttracer_create_p(&url, &method);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_outgoingwebrequesttracer_add_request_headers_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* names, onesdk_string_t const* values, onesdk_size_t count);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_outgoingwebrequesttracer_add_request_header(onesdk_tracer_handle_t tracer_handle, onesdk_string_t name, onesdk_string_t value) {
    onesdk_outgoingwebrequesttracer_add_request_headers_p(tracer_handle, &name, &value, 1);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_outgoingwebrequesttracer_add_response_headers_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* names, onesdk_string_t const* values, onesdk_size_t count);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_outgoingwebrequesttracer_add_response_header(onesdk_tracer_handle_t tracer_handle, onesdk_string_t name, onesdk_string_t value) {
    onesdk_outgoingwebrequesttracer_add_response_headers_p(tracer_handle, &name, &value, 1);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_outgoingwebrequesttracer_set_status_code(onesdk_tracer_handle_t tracer_handle, onesdk_int32_t status_code);

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_customservicetracer_create_p(onesdk_string_t const* service_method, onesdk_string_t const* service_name);

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_tracer_handle_t) onesdk_customservicetracer_create(onesdk_string_t service_method, onesdk_string_t service_name) {
    return onesdk_customservicetracer_create_p(&service_method, &service_name);
}

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_messagingsysteminfo_handle_t) onesdk_messagingsysteminfo_create_p(
    onesdk_string_t const* vendor_name, onesdk_string_t const* destination_name, onesdk_int32_t destination_type, onesdk_int32_t channel_type, onesdk_string_t const* channel_endpoint);

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_messagingsysteminfo_handle_t) onesdk_messagingsysteminfo_create(
    onesdk_string_t vendor_name, onesdk_string_t destination_name, onesdk_int32_t destination_type, onesdk_int32_t channel_type, onesdk_string_t channel_endpoint
) {
    return onesdk_messagingsysteminfo_create_p(&vendor_name, &destination_name, destination_type, channel_type, &channel_endpoint);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_messagingsysteminfo_delete(onesdk_messagingsysteminfo_handle_t messagingsysteminfo_handle);

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_outgoingmessagetracer_create(onesdk_messagingsysteminfo_handle_t messagingsysteminfo_handle);

ONESDK_DECLARE_FUNCTION(void) onesdk_outgoingmessagetracer_set_vendor_message_id_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* vendor_message_id);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_outgoingmessagetracer_set_vendor_message_id(onesdk_tracer_handle_t tracer_handle, onesdk_string_t vendor_message_id) {
    onesdk_outgoingmessagetracer_set_vendor_message_id_p(tracer_handle, &vendor_message_id);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_outgoingmessagetracer_set_correlation_id_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* correlation_id);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_outgoingmessagetracer_set_correlation_id(onesdk_tracer_handle_t tracer_handle, onesdk_string_t correlation_id) {
    onesdk_outgoingmessagetracer_set_correlation_id_p(tracer_handle, &correlation_id);
}

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_incomingmessagereceivetracer_create(onesdk_messagingsysteminfo_handle_t messagingsysteminfo_handle);

ONESDK_DECLARE_FUNCTION(onesdk_tracer_handle_t) onesdk_incomingmessageprocesstracer_create(onesdk_messagingsysteminfo_handle_t messagingsysteminfo_handle);

ONESDK_DECLARE_FUNCTION(void) onesdk_incomingmessageprocesstracer_set_vendor_message_id_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* vendor_message_id);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_incomingmessageprocesstracer_set_vendor_message_id(onesdk_tracer_handle_t tracer_handle, onesdk_string_t vendor_message_id) {
    onesdk_incomingmessageprocesstracer_set_vendor_message_id_p(tracer_handle, &vendor_message_id);
}

ONESDK_DECLARE_FUNCTION(void) onesdk_incomingmessageprocesstracer_set_correlation_id_p(onesdk_tracer_handle_t tracer_handle, onesdk_string_t const* correlation_id);

ONESDK_DEFINE_INLINE_FUNCTION(void) onesdk_incomingmessageprocesstracer_set_correlation_id(onesdk_tracer_handle_t tracer_handle, onesdk_string_t correlation_id) {
    onesdk_incomingmessageprocesstracer_set_correlation_id_p(tracer_handle, &correlation_id);
}

/*========================================================================================================================================*/

/*========================================================================================================================================*/

ONESDK_DECLARE_FUNCTION(onesdk_result_t) onesdk_tracecontext_get_current(
    char* trace_id_buffer, onesdk_size_t trace_id_buffer_size, char* span_id_buffer, onesdk_size_t span_id_buffer_size);


/*========================================================================================================================================*/

#endif /* ONESDK_AGENT_H_INCLUDED */