Merge pull request #5 from Dynatrace/prepare-1.3.2

Update to version 1.3.2.

README.md

@@ -5,13 +5,45 @@
 This SDK enables Dynatrace customers to extend request level visibility into any native process. The SDK is C based and thus can be used in any C or C++ application. It can also be used in other languages via language bindings.
 In order to use the development kit you need to have access to the source code of the application in question.
 
+This is the official C/C++ implementation of the [Dynatrace OneAgent SDK](https://github.com/Dynatrace/OneAgent-SDK/).
+<!-- Generate with https://github.com/jonschlinkert/markdown-toc -->
+
+<!-- toc -->
+
+- [Package contents](#package-contents)
+- [Features](#features)
+- [Documentation](#documentation)
+- [Getting started](#getting-started)
+- [Building and linking against the Dynatrace OneAgent SDK](#building-and-linking-against-the-dynatrace-oneagent-sdk)
+ * [Using CMake](#using-cmake)
+ * [Auto-linking with Visual Studio](#auto-linking-with-visual-studio)
+ * [Other build systems](#other-build-systems)
+ * [Using CMake to build the samples](#using-cmake-to-build-the-samples)
+- [Initializing the Dynatrace OneAgent SDK](#initializing-the-dynatrace-oneagent-sdk)
+- [Using the Dynatrace OneAgent SDK to trace remote calls](#using-the-dynatrace-oneagent-sdk-to-trace-remote-calls)
+- [Using the Dynatrace OneAgent SDK to trace SQL based database calls](#using-the-dynatrace-oneagent-sdk-to-trace-sql-based-database-calls)
+- [Using the Dynatrace OneAgent SDK to trace incoming web requests](#using-the-dynatrace-oneagent-sdk-to-trace-incoming-web-requests)
+- [Using the Dynatrace OneAgent SDK to trace outgoing web requests](#using-the-dynatrace-oneagent-sdk-to-trace-outgoing-web-requests)
+- [Using the Dynatrace OneAgent SDK to trace asynchronous activities](#using-the-dynatrace-oneagent-sdk-to-trace-asynchronous-activities)
+- [Using the Dynatrace OneAgent SDK to add custom request attributes](#using-the-dynatrace-oneagent-sdk-to-add-custom-request-attributes)
+- [Using the Dynatrace OneAgent SDK with forked child processes (only available on Linux)](#using-the-dynatrace-oneagent-sdk-with-forked-child-processes-only-available-on-linux)
+- [Troubleshooting](#troubleshooting)
+- [Requirements](#requirements)
+ * [Compatibility of Dynatrace OneAgent SDK for C/C++ releases with OneAgent releases](#compatibility-of-dynatrace-oneagent-sdk-for-cc-releases-with-oneagent-releases)
+- [Help & Support](#help--support)
+ * [Read the manual](#read-the-manual)
+ * [Let us help you](#let-us-help-you)
+- [Release Notes](#release-notes)
+
+<!-- tocstop -->
 
 ## Package contents
 
 The SDK package includes
-- The libraries and header files necessary for instrumenting applications
-- A simple sample application
-- Reference documentation
+- `lib` and `include`: The libraries and header files necessary for instrumenting applications
+- `*.cmake`: Optional support files to use the libraries more easily with the CMake build system.
+- `samples/sample1`: A simple sample application
+- `docs`: Reference documentation
 
 
 ## Features
@@ -38,6 +70,7 @@ To start using the Dynatrace OneAgent SDK for C/C++, simply download the latest
 The source archive also includes all necessary artifacts (e.g. the static and dynamic library files), so this is all you need.
 Extract the archive to a local folder on your machine and then add the appropriate "include" and "lib" paths to your build system.
 
+To see if your platform is supported, refer to [requirements](#requirements).
 
 ## Building and linking against the Dynatrace OneAgent SDK
 
@@ -410,7 +443,7 @@ To add a custom request attribute, simply call one of the `onesdk_customrequesta
 This will add the custom request attributes to the currently traced service. If no tracer is active, the values will be discarded.
 
 
-## Using the Dynatrace OneAgent SDK with forked child processes (not available on Windows)
+## Using the Dynatrace OneAgent SDK with forked child processes (only available on Linux)
 
 Some applications, especially web servers, use a concurrency model that is based on forked child processes. Typically a master process
 is started which is responsible only for creating and managing child processes by means of forking. The child processes do the real work,
@@ -543,33 +576,69 @@ This will provide additional debug information in agent log file. (Alternatively
 
 To troubleshoot SDK issues you can also use the SDK's agent logging callback - see `onesdk_agent_set_logging_callback` in the reference documentation.
 
+<a name="requirements"></a>
 
-## Dynatrace OneAgent SDK for C/C++ Requirements
+## Requirements
 
-- Dynatrace OneAgent needs to be installed on the system that is to be monitored (supported versions see below)
-- Supported environments include all Windows or Linux x86 environments
-- musl libc is currently not supported (e.g. used in Alpine Linux)
+- Dynatrace OneAgent needs to be installed on the system that is to be monitored (required versions see below)
+- The supported environments are:
+ + Windows on x86
+ + Linux on x86. musl libc is currently not supported (e.g. used in Alpine Linux)
+ + Solaris on SPARC (x86 is *not* supported).
+ Support for this platform is new since version 1.3.2 of the SDK.
 
+ Refer to https://www.dynatrace.com/support/help/shortlink/supported-technologies#operating-systems for the exact versions supported by
+ OneAgent. Note that only the subset of operating systems and processor architectures explicitly listed above in this README are supported
+ by the SDK.
 
-## Compatibility of Dynatrace OneAgent SDK for C/C++ releases with OneAgent releases
+### Compatibility of Dynatrace OneAgent SDK for C/C++ releases with OneAgent releases
 
 |OneAgent SDK for C/C++|Dynatrace OneAgent|
 |:---------------------|:-----------------|
+|1.3.2 |>=1.159 |
 |1.3.1 |>=1.151 |
 |1.2.0 |>=1.147 |
 |1.1.0 |>=1.141 |
 |1.0.0 |>=1.133 |
 
 
-## Support
+<a name="help" />
 
-The Dynatrace OneAgent SDK is currently in early access. Please report tickets via the [GitHub issue tracker](https://github.com/Dynatrace/OneAgent-SDK-for-C/issues).
+## Help & Support
+
+The Dynatrace OneAgent SDK for C/C++ is an open source project, currently in beta status. The features are fully supported by Dynatrace. 
+
+### Read the manual
+
+* The most recent version of the reference documentation can be viewed at https://dynatrace.github.io/OneAgent-SDK-for-C/
+* A high level documentation/description of OneAgent SDK concepts is available at https://github.com/Dynatrace/OneAgent-SDK/.
+* Of course, this README also contains lots of useful information.
+
+### Let us help you
+
+**Get Help**
+* Ask a question in the <a href="https://answers.dynatrace.com/spaces/482/view.html" target="_blank">product forums</a>
+* Read the <a href="https://www.dynatrace.com/support/help/" target="_blank">product documentation</a>
+
+**Open a <a href="https://github.com/Dynatrace/OneAgent-SDK-for-Java/issues">GitHub issue</a> to:**
+* Report minor defects, minor items or typos
+* Ask for improvements or changes in the SDK API
+* Ask any questions related to the community effort
+
+SLAs don't apply for GitHub tickets
+
+**Customers can open a ticket on the <a href="https://support.dynatrace.com/supportportal/" target="_blank">Dynatrace support portal</a> to:**
+* Get support from the Dynatrace technical support engineering team
+* Manage and resolve product related technical issues
+
+SLAs apply according to the customer's support level.
 
 
 ## Release Notes
 
 |Version|Description |
 |:------|:-----------------------------------------------------------------------------------------------------------------------|
+|1.3.2 |Support for Solaris SPARC |
 |1.3.1 |Support for monitoring forked child processes, added new API to check agent version compatibility |
 |1.2.0 |Added in-process linking, added custom request attributes, added outgoing web request tracers |
 |1.1.0 |Added incoming web request tracers, added row count & round trip count for DB request tracers |

docs/annotated.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">Dynatrace OneAgent SDK for C/C++
- &#160;<span id="projectnumber">1.3.1.0</span>
+ &#160;<span id="projectnumber">1.3.2.0</span>
  </div>
  </td>
  </tr>

docs/classes.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">Dynatrace OneAgent SDK for C/C++
- &#160;<span id="projectnumber">1.3.1.0</span>
+ &#160;<span id="projectnumber">1.3.2.0</span>
  </div>
  </td>
  </tr>
@@ -63,15 +63,15 @@
 <div class="title">Class Index</div> </div>
 </div><!--header-->
 <div class="contents">
-<div class="qindex"><a class="qindex" href="#letter_o">o</a></div>
+<div class="qindex"><a class="qindex" href="#letter_s">s</a></div>
 <table class="classindex">
-<tr><td rowspan="2" valign="bottom"><a name="letter_o"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;o&#160;&#160;</div></td></tr></table>
+<tr><td rowspan="2" valign="bottom"><a name="letter_s"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;s&#160;&#160;</div></td></tr></table>
 </td><td valign="top"><a class="el" href="structonesdk__stub__version__t.html">onesdk_stub_version_t</a>&#160;&#160;&#160;</td><td></td></tr>
 <tr><td></td><td></td></tr>
 <tr><td valign="top"><a class="el" href="structonesdk__string__t.html">onesdk_string_t</a>&#160;&#160;&#160;</td><td></td><td></td></tr>
 <tr><td></td><td></td><td></td></tr>
 </table>
-<div class="qindex"><a class="qindex" href="#letter_o">o</a></div>
+<div class="qindex"><a class="qindex" href="#letter_s">s</a></div>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

docs/dir_57326019c1f2447d742e07b3707bbe0e.html → docs/dir_17f0c76cb54783b10a44b9cb754671fd.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">Dynatrace OneAgent SDK for C/C++
- &#160;<span id="projectnumber">1.3.1.0</span>
+ &#160;<span id="projectnumber">1.3.2.0</span>
  </div>
  </td>
  </tr>
@@ -59,7 +59,7 @@
 
 <div id="nav-path" class="navpath">
  <ul>
-<li class="navelem"><a class="el" href="dir_57326019c1f2447d742e07b3707bbe0e.html">onesdk</a></li> </ul>
+<li class="navelem"><a class="el" href="dir_17f0c76cb54783b10a44b9cb754671fd.html">onesdk</a></li> </ul>
 </div>
 </div><!-- top -->
 <div class="header">

docs/dir_1f5a7321052bf06dbe22563e4de8979c.html

@@ -0,0 +1,91 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Dynatrace OneAgent SDK for C/C++: onesdk/experimental Directory Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">Dynatrace OneAgent SDK for C/C++
+ &#160;<span id="projectnumber">1.4.0.0</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div id="nav-path" class="navpath">
+ <ul>
+<li class="navelem"><a class="el" href="dir_e11ff9dae1e7a45d3f00d4242cad749e.html">onesdk</a></li><li class="navelem"><a class="el" href="dir_1f5a7321052bf06dbe22563e4de8979c.html">experimental</a></li> </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+ <div class="headertitle">
+<div class="title">experimental Directory Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
+Files</h2></td></tr>
+<tr class="memitem:onesdk__ex__common_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="onesdk__ex__common_8h.html">onesdk_ex_common.h</a> <a href="onesdk__ex__common_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:onesdk__ex__common_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines common experimental types/constants/macros. Applications should not include this file directly. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:onesdk__ex__span_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="onesdk__ex__span_8h.html">onesdk_ex_span.h</a> <a href="onesdk__ex__span_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:onesdk__ex__span_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines experimental agent extension functions for (OpenTracing, OpenCensus) spans. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:onesdk__ex__tracer__ext_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="onesdk__ex__tracer__ext_8h.html">onesdk_ex_tracer_ext.h</a> <a href="onesdk__ex__tracer__ext_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:onesdk__ex__tracer__ext_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines experimental agent extension functions for tracers. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>

docs/dir_e11ff9dae1e7a45d3f00d4242cad749e.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">Dynatrace OneAgent SDK for C/C++
- &#160;<span id="projectnumber">1.3.1.0</span>
+ &#160;<span id="projectnumber">1.3.2.0</span>
  </div>
  </td>
  </tr>

docs/files.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">Dynatrace OneAgent SDK for C/C++
- &#160;<span id="projectnumber">1.3.1.0</span>
+ &#160;<span id="projectnumber">1.3.2.0</span>
  </div>
  </td>
  </tr>
@@ -65,7 +65,7 @@
 <div class="contents">
 <div class="textblock">Here is a list of all documented files with brief descriptions:</div><div class="directory">
 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
-<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span id="img_0_" class="iconfopen" onclick="toggleFolder('0_')">&#160;</span><a class="el" href="dir_57326019c1f2447d742e07b3707bbe0e.html" target="_self">onesdk</a></td><td class="desc"></td></tr>
+<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span id="img_0_" class="iconfopen" onclick="toggleFolder('0_')">&#160;</span><a class="el" href="dir_17f0c76cb54783b10a44b9cb754671fd.html" target="_self">onesdk</a></td><td class="desc"></td></tr>
 <tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="onesdk__version_8h_source.html"><span class="icondoc"></span></a><a class="el" href="onesdk__version_8h.html" target="_self">onesdk_version.h</a></td><td class="desc">Defines the version of the SDK stub. Applications should not include this file directly </td></tr>
 <tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span id="img_1_" class="iconfopen" onclick="toggleFolder('1_')">&#160;</span><a class="el" href="dir_e11ff9dae1e7a45d3f00d4242cad749e.html" target="_self">onesdk</a></td><td class="desc"></td></tr>
 <tr id="row_1_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="onesdk_8h_source.html"><span class="icondoc"></span></a><a class="el" href="onesdk_8h.html" target="_self">onesdk.h</a></td><td class="desc">Main include file for the SDK - includes everything </td></tr>

docs/functions.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">Dynatrace OneAgent SDK for C/C++
- &#160;<span id="projectnumber">1.3.1.0</span>
+ &#160;<span id="projectnumber">1.3.2.0</span>
  </div>
  </td>
  </tr>

docs/functions_vars.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">Dynatrace OneAgent SDK for C/C++
- &#160;<span id="projectnumber">1.3.1.0</span>
+ &#160;<span id="projectnumber">1.3.2.0</span>
  </div>
  </td>
  </tr>