| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.trace, class: OpenTelemetryClassRule"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.trace;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import io.opentelemetry.api.GlobalOpenTelemetry;</span> |
| <span class="source-line-no">021</span><span id="line-21">import io.opentelemetry.api.OpenTelemetry;</span> |
| <span class="source-line-no">022</span><span id="line-22">import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;</span> |
| <span class="source-line-no">023</span><span id="line-23">import io.opentelemetry.context.propagation.ContextPropagators;</span> |
| <span class="source-line-no">024</span><span id="line-24">import io.opentelemetry.sdk.OpenTelemetrySdk;</span> |
| <span class="source-line-no">025</span><span id="line-25">import io.opentelemetry.sdk.testing.exporter.InMemorySpanExporter;</span> |
| <span class="source-line-no">026</span><span id="line-26">import io.opentelemetry.sdk.testing.junit4.OpenTelemetryRule;</span> |
| <span class="source-line-no">027</span><span id="line-27">import io.opentelemetry.sdk.trace.SdkTracerProvider;</span> |
| <span class="source-line-no">028</span><span id="line-28">import io.opentelemetry.sdk.trace.data.SpanData;</span> |
| <span class="source-line-no">029</span><span id="line-29">import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;</span> |
| <span class="source-line-no">030</span><span id="line-30">import java.util.List;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.junit.rules.ExternalResource;</span> |
| <span class="source-line-no">032</span><span id="line-32"></span> |
| <span class="source-line-no">033</span><span id="line-33">/**</span> |
| <span class="source-line-no">034</span><span id="line-34"> * <p></span> |
| <span class="source-line-no">035</span><span id="line-35"> * Like {@link OpenTelemetryRule}, except modeled after the junit5 implementation</span> |
| <span class="source-line-no">036</span><span id="line-36"> * {@code OpenTelemetryExtension}. Use this class when you need to make asserts on {@link SpanData}</span> |
| <span class="source-line-no">037</span><span id="line-37"> * created on a MiniCluster. Make sure this rule initialized before the MiniCluster so that it can</span> |
| <span class="source-line-no">038</span><span id="line-38"> * register its instance of {@link OpenTelemetry} as the global instance before any server-side</span> |
| <span class="source-line-no">039</span><span id="line-39"> * component can call {@link TraceUtil#getGlobalTracer()}.</span> |
| <span class="source-line-no">040</span><span id="line-40"> * </p></span> |
| <span class="source-line-no">041</span><span id="line-41"> * <p></span> |
| <span class="source-line-no">042</span><span id="line-42"> * For example:</span> |
| <span class="source-line-no">043</span><span id="line-43"> * </p></span> |
| <span class="source-line-no">044</span><span id="line-44"> *</span> |
| <span class="source-line-no">045</span><span id="line-45"> * <pre></span> |
| <span class="source-line-no">046</span><span id="line-46"> * {</span> |
| <span class="source-line-no">047</span><span id="line-47"> * &#64;code</span> |
| <span class="source-line-no">048</span><span id="line-48"> * public class TestMyClass {</span> |
| <span class="source-line-no">049</span><span id="line-49"> * private static final OpenTelemetryClassRule otelClassRule = OpenTelemetryClassRule.create();</span> |
| <span class="source-line-no">050</span><span id="line-50"> * private static final MiniClusterRule miniClusterRule = MiniClusterRule.newBuilder().build();</span> |
| <span class="source-line-no">051</span><span id="line-51"> * protected static final ConnectionRule connectionRule =</span> |
| <span class="source-line-no">052</span><span id="line-52"> * ConnectionRule.createAsyncConnectionRule(miniClusterRule::createAsyncConnection);</span> |
| <span class="source-line-no">053</span><span id="line-53"> *</span> |
| <span class="source-line-no">054</span><span id="line-54"> * &#64;ClassRule</span> |
| <span class="source-line-no">055</span><span id="line-55"> * public static final TestRule classRule =</span> |
| <span class="source-line-no">056</span><span id="line-56"> * RuleChain.outerRule(otelClassRule).around(miniClusterRule).around(connectionRule);</span> |
| <span class="source-line-no">057</span><span id="line-57"> *</span> |
| <span class="source-line-no">058</span><span id="line-58"> * &#64;Rule</span> |
| <span class="source-line-no">059</span><span id="line-59"> * public final OpenTelemetryTestRule otelTestRule = new OpenTelemetryTestRule(otelClassRule);</span> |
| <span class="source-line-no">060</span><span id="line-60"> *</span> |
| <span class="source-line-no">061</span><span id="line-61"> * &#64;Test</span> |
| <span class="source-line-no">062</span><span id="line-62"> * public void myTest() {</span> |
| <span class="source-line-no">063</span><span id="line-63"> * // ...</span> |
| <span class="source-line-no">064</span><span id="line-64"> * // do something that makes spans</span> |
| <span class="source-line-no">065</span><span id="line-65"> * final List<SpanData> spans = otelClassRule.getSpans();</span> |
| <span class="source-line-no">066</span><span id="line-66"> * // make assertions on them</span> |
| <span class="source-line-no">067</span><span id="line-67"> * }</span> |
| <span class="source-line-no">068</span><span id="line-68"> * }</span> |
| <span class="source-line-no">069</span><span id="line-69"> * }</span> |
| <span class="source-line-no">070</span><span id="line-70"> * </pre></span> |
| <span class="source-line-no">071</span><span id="line-71"> *</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @see <a href=</span> |
| <span class="source-line-no">073</span><span id="line-73"> * "https://github.com/open-telemetry/opentelemetry-java/blob/9a330d0/sdk/testing/src/main/java/io/opentelemetry/sdk/testing/junit5/OpenTelemetryExtension.java">junit5/OpenTelemetryExtension.java</a></span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75">public final class OpenTelemetryClassRule extends ExternalResource {</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> public static OpenTelemetryClassRule create() {</span> |
| <span class="source-line-no">078</span><span id="line-78"> InMemorySpanExporter spanExporter = InMemorySpanExporter.create();</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> SdkTracerProvider tracerProvider = SdkTracerProvider.builder()</span> |
| <span class="source-line-no">081</span><span id="line-81"> .addSpanProcessor(SimpleSpanProcessor.create(spanExporter)).build();</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> OpenTelemetrySdk openTelemetry = OpenTelemetrySdk.builder()</span> |
| <span class="source-line-no">084</span><span id="line-84"> .setPropagators(ContextPropagators.create(W3CTraceContextPropagator.getInstance()))</span> |
| <span class="source-line-no">085</span><span id="line-85"> .setTracerProvider(tracerProvider).build();</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> return new OpenTelemetryClassRule(openTelemetry, spanExporter);</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> private final OpenTelemetrySdk openTelemetry;</span> |
| <span class="source-line-no">091</span><span id="line-91"> private final InMemorySpanExporter spanExporter;</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> private OpenTelemetryClassRule(final OpenTelemetrySdk openTelemetry,</span> |
| <span class="source-line-no">094</span><span id="line-94"> final InMemorySpanExporter spanExporter) {</span> |
| <span class="source-line-no">095</span><span id="line-95"> this.openTelemetry = openTelemetry;</span> |
| <span class="source-line-no">096</span><span id="line-96"> this.spanExporter = spanExporter;</span> |
| <span class="source-line-no">097</span><span id="line-97"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> /** Returns the {@link OpenTelemetry} created by this Rule. */</span> |
| <span class="source-line-no">100</span><span id="line-100"> public OpenTelemetry getOpenTelemetry() {</span> |
| <span class="source-line-no">101</span><span id="line-101"> return openTelemetry;</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> /** Returns all the exported {@link SpanData} so far. */</span> |
| <span class="source-line-no">105</span><span id="line-105"> public List<SpanData> getSpans() {</span> |
| <span class="source-line-no">106</span><span id="line-106"> return spanExporter.getFinishedSpanItems();</span> |
| <span class="source-line-no">107</span><span id="line-107"> }</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> /**</span> |
| <span class="source-line-no">110</span><span id="line-110"> * Clears the collected exported {@link SpanData}.</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> public void clearSpans() {</span> |
| <span class="source-line-no">113</span><span id="line-113"> spanExporter.reset();</span> |
| <span class="source-line-no">114</span><span id="line-114"> }</span> |
| <span class="source-line-no">115</span><span id="line-115"></span> |
| <span class="source-line-no">116</span><span id="line-116"> @Override</span> |
| <span class="source-line-no">117</span><span id="line-117"> protected void before() throws Throwable {</span> |
| <span class="source-line-no">118</span><span id="line-118"> GlobalOpenTelemetry.resetForTest();</span> |
| <span class="source-line-no">119</span><span id="line-119"> GlobalOpenTelemetry.set(openTelemetry);</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"></span> |
| <span class="source-line-no">122</span><span id="line-122"> @Override</span> |
| <span class="source-line-no">123</span><span id="line-123"> protected void after() {</span> |
| <span class="source-line-no">124</span><span id="line-124"> GlobalOpenTelemetry.resetForTest();</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
