Skip to content

Commit

Permalink
Merge pull request #2009 from newrelic/update-javadoc-comments
Browse files Browse the repository at this point in the history
Update Javadoc comments for @trace API
  • Loading branch information
jasonjkeller authored Aug 14, 2024
2 parents 07e00e3 + 049c947 commit 0c73dac
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions newrelic-api/src/main/java/com/newrelic/api/agent/Trace.java
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@

/**
* Sets the metric name for this tracer. If unspecified, the class / method name will be used.
*
* When using both nameTransaction and metricName, nameTransaction will take precedence and the
* transaction will use the name from the underlying tracer (typically class/method), rather than the
* custom name set by metricName. It is recommended to use one or the other depending on naming preferences.
*
* @return The metric name for this tracer.
* @since 1.3.0
Expand Down Expand Up @@ -75,6 +79,10 @@

/**
* Names the current transaction using this tracer's metric name.
*
* When using both nameTransaction and metricName, nameTransaction will take precedence and the
* transaction will use the name from the underlying tracer (typically class/method), rather than the
* custom name set by metricName. It is recommended to use one or the other depending on naming preferences.
*
* @return True if this traced method should be used to name the transaction, else false.
* @since 3.1.0
Expand Down

0 comments on commit 0c73dac

Please sign in to comment.