Merge pull request #12 from Dynatrace/prepare_release_1.6

README.md

@@ -30,7 +30,7 @@ This is the official C/C++ implementation of the [Dynatrace OneAgent SDK](https:
  * [Trace messaging](#trace-messaging)
  * [Trace custom service methods](#trace-custom-service-methods)
  * [Add custom request attributes](#add-custom-request-attributes)
- * [Report metrics (preview feature)](#report-metrics-preview-feature)
+ * [Report metrics (deprecated)](#metrics)
 - [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)
@@ -728,9 +728,13 @@ This will add the custom request attributes to the currently traced service. If
 <a name="report-metrics"></a>
 <a name="report-metrics-preview-feature"></a>
 
-### Report metrics (preview feature)
+### Report metrics (deprecated)
 
-**The metrics API is currently part of a preview program and will not work for users outside of the preview program. Visit [Dynatrace Help][previewhelp] for details.**
+> **Note**: The metrics API was part of a
+> [Dynatrace preview program](https://www.dynatrace.com/support/help/whats-new/preview-and-early-adopter-releases/)
+> that has been **discontinued**. All metrics-related APIs have been **deprecated** and will be removed in a future release.
+> The [Metric ingestion page][mint] provides further information on how to replace these APIs and how to report
+> metrics data from now on.
 
 You can report metrics (i.e., time series data) using the OneAgent SDK. Counters, gauges and statistic metrics for floating point and integer numbers with one or zero additional dimensions are supported. Make sure to read the [reference documentation][metricref] to find out which metric is right for your use case. To give you an example of an integer gauge with one additional dimensions:
 
@@ -748,17 +752,19 @@ You can report metrics (i.e., time series data) using the OneAgent SDK. Counters
  onesdk_metric_delete(mqsize_metric);
 ```
 
-In general you should try to use the same metric handle for the same metric instead of creating a new handle each time you report a value.
+In general, you should try to use the same metric handle for the same metric instead of creating a new handle each time you report a value.
 
 You will need to subscribe to the metric in Dynatrace to see it. If a metric is not subscribed the agent will efficiently discard it.
 
 Note that metrics will currently not work when the SDK is initialized in [forkable mode](#forking).
 
 > 📕 [Reference documentation for metrics][metricref] 
-> ➡️ [Dynatrace Help on preview features][previewhelp]
+> ➡️ [Dynatrace Help on preview features][previewhelp] 
+> ➡️ [Dynatrace Metric ingestion][mint]
 
 [metricref]: https://dynatrace.github.io/OneAgent-SDK-for-C/group__ex__metrics.html
 [previewhelp]: https://www.dynatrace.com/support/help/shortlink/preview-and-early-adopter-releases
+[mint]: https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/
 
 <a name="forking"></a>
 <a name="using-the-dynatrace-oneagent-sdk-with-forked-child-processes-only-available-on-linux"></a>
@@ -938,6 +944,7 @@ This will provide additional debug information in agent log file. (Alternatively
 
 |OneAgent SDK for C/C++|Dynatrace OneAgent|Support status|
 |:---------------------|:-----------------|:-------------|
+|1.6.1 |>=1.179 |Supported |
 |1.5.1 |>=1.179 |Supported |
 |1.4.1 |>=1.161 |Supported |
 |1.3.2 |>=1.159 |Supported |
@@ -996,6 +1003,7 @@ See also https://github.com/Dynatrace/OneAgent-SDK-for-C/releases.
 
 |Version|Description |
 |:------|:-----------------------------------------------------------------------------------------------------------------------|
+|1.6.1 |Deprecate metrics-related APIs. <br> Don't look for agent module in `PATH/LD_LIBRARY_PATH/...`, disallow relative `DT_HOME` on Windows (prevent DLL hijacking) |
 |1.5.1 |Added metrics APIs (preview feature), improved logging callback APIs, new API to query fork state |
 |1.4.1 |Added custom service tracers and messaging tracers |
 |1.3.2 |Support for Solaris SPARC |

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.5.1.4</span>
+ &#160;<span id="projectnumber">1.6.1.3</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.5.1.4</span>
+ &#160;<span id="projectnumber">1.6.1.3</span>
  </div>
  </td>
  </tr>

docs/deprecated.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.5.1.4</span>
+ &#160;<span id="projectnumber">1.6.1.3</span>
  </div>
  </td>
  </tr>
@@ -64,10 +64,40 @@
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><dl class="reflist">
+<dt><a class="anchor" id="_deprecated000003"></a>Module <a class="el" href="group__ex__metrics.html">ex_metrics</a> </dt>
+<dd><p class="startdd">From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details.</p>
+<p class="enddd"></p>
+</dd>
 <dt><a class="anchor" id="_deprecated000001"></a>Member <a class="el" href="group__misc.html#ga3962855fa4d4c78665b96c5b12774c02">onesdk_agent_set_logging_callback</a> (onesdk_agent_logging_callback_t *agent_logging_callback)</dt>
 <dd>From 1.5 on, use <a class="el" href="group__misc.html#ga31c7f418f4b3515097434f8df6810cad">onesdk_agent_set_warning_callback</a> instead, which has a return code but is otherwise the same (<code>onesdk_agent_set_logging_callback</code>, like <a class="el" href="group__misc.html#ga31c7f418f4b3515097434f8df6810cad">onesdk_agent_set_warning_callback</a>, can fail but it has no way to report errors). </dd>
 <dt><a class="anchor" id="_deprecated000002"></a>Member <a class="el" href="group__messaging.html#gab864ee6a425cc9b238499898ebdc36bb">ONESDK_DYNATRACE_MESSAGE_PROPERTYNAME</a> </dt>
-<dd>Use <a class="el" href="group__messaging.html#ga2f13c9540fec16785224aa5c5c2f46c7">ONESDK_DYNATRACE_MESSAGE_PROPERTY_NAME</a> instead. </dd>
+<dd>Use <a class="el" href="group__messaging.html#ga2f13c9540fec16785224aa5c5c2f46c7">ONESDK_DYNATRACE_MESSAGE_PROPERTY_NAME</a> instead. </dd>
+<dt><a class="anchor" id="_deprecated000006"></a>Member <a class="el" href="group__ex__metrics.html#ga6f88aea07c31e24ad91607dc60aae73f">onesdk_floatcountermetric_create</a> (<a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> metric_key, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> unit, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension_name)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000012"></a>Member <a class="el" href="group__ex__metrics.html#ga8cee17ea303df14bf36b8fbed7edae47">onesdk_floatcountermetric_increase_by</a> (onesdk_metric_handle_t metric_handle, double delta, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000008"></a>Member <a class="el" href="group__ex__metrics.html#gae6bf5257b09c5196f4c8708c119445b0">onesdk_floatgaugemetric_create</a> (<a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> metric_key, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> unit, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension_name)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000014"></a>Member <a class="el" href="group__ex__metrics.html#ga9145f010e73b36da39bf50f0f5973572">onesdk_floatgaugemetric_set_value</a> (onesdk_metric_handle_t metric_handle, double value, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000016"></a>Member <a class="el" href="group__ex__metrics.html#ga4d5558f2c4dae5854d78023c17819d39">onesdk_floatstatisticsmetric_add_value</a> (onesdk_metric_handle_t metric_handle, double value, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000010"></a>Member <a class="el" href="group__ex__metrics.html#gac4c0e9bea0f56837d7e7f1ed42577759">onesdk_floatstatisticsmetric_create</a> (<a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> metric_key, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> unit, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension_name)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000005"></a>Member <a class="el" href="group__ex__metrics.html#ga4df0115a42e29e545cbc7644b162357f">onesdk_integercountermetric_create</a> (<a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> metric_key, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> unit, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension_name)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000011"></a>Member <a class="el" href="group__ex__metrics.html#gae7cb959a33fa7fc964aea5fd100810a4">onesdk_integercountermetric_increase_by</a> (onesdk_metric_handle_t metric_handle, onesdk_int64_t delta, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000007"></a>Member <a class="el" href="group__ex__metrics.html#gad5baa2a5373fe29d08776c92abd30e3d">onesdk_integergaugemetric_create</a> (<a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> metric_key, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> unit, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension_name)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000013"></a>Member <a class="el" href="group__ex__metrics.html#ga147b93f71805679336870fa6de415e87">onesdk_integergaugemetric_set_value</a> (onesdk_metric_handle_t metric_handle, onesdk_int64_t value, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000015"></a>Member <a class="el" href="group__ex__metrics.html#ga70abbd580d6c223f80fc8f777b6e0c19">onesdk_integerstatisticsmetric_add_value</a> (onesdk_metric_handle_t metric_handle, onesdk_int64_t value, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000009"></a>Member <a class="el" href="group__ex__metrics.html#ga52abb0e4db81c1c020035c69cdae6496">onesdk_integerstatisticsmetric_create</a> (<a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> metric_key, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> unit, <a class="el" href="structonesdk__string__t.html" title="Represents a reference to string data in a user specified encoding. ">onesdk_string_t</a> dimension_name)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details. </dd>
+<dt><a class="anchor" id="_deprecated000004"></a>Member <a class="el" href="group__ex__metrics.html#ga2aa49a9e686e4baf89c701e69f557e20">onesdk_metric_delete</a> (onesdk_metric_handle_t metric_handle)</dt>
+<dd>From 1.6 on, all metrics-related APIs are deprecated and will be removed in a future release. Refer to <a href="https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics">https://github.com/Dynatrace/OneAgent-SDK-for-c#metrics</a> for details.</dd>
 </dl>
 </div></div><!-- contents -->
 <!-- start footer part -->

docs/dir_00c011bef261143570b84b595a5a55cb.html → docs/dir_2a29f73025fe91cc3aed2b0949f7b311.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.5.1.4</span>
+ &#160;<span id="projectnumber">1.6.1.3</span>
  </div>
  </td>
  </tr>
@@ -59,7 +59,7 @@
 
 <div id="nav-path" class="navpath">
  <ul>
-<li class="navelem"><a class="el" href="dir_00c011bef261143570b84b595a5a55cb.html">onesdk</a></li> </ul>
+<li class="navelem"><a class="el" href="dir_2a29f73025fe91cc3aed2b0949f7b311.html">onesdk</a></li> </ul>
 </div>
 </div><!-- top -->
 <div class="header">
@@ -94,6 +94,9 @@
 <tr class="memitem:onesdk__string_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="onesdk__string_8h.html">onesdk_string.h</a> <a href="onesdk__string_8h_source.html">[code]</a></td></tr>
 <tr class="memdesc:onesdk__string_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines <a class="el" href="structonesdk__string__t.html">onesdk_string_t</a>, the string type used for tracing, plus related utility functions. <br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:onesdk__version_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="onesdk__version_8h.html">onesdk_version.h</a> <a href="onesdk__version_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:onesdk__version_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the version of the SDK stub. Applications should not include this file directly. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 </div><!-- contents -->
 <!-- start footer part -->