|
| 1 | +/* |
| 2 | + * SPDX-License-Identifier: Apache-2.0 |
| 3 | + * |
| 4 | + * The OpenSearch Contributors require contributions made to |
| 5 | + * this file be licensed under the Apache-2.0 license or a |
| 6 | + * compatible open source license. |
| 7 | + */ |
| 8 | + |
| 9 | +package org.opensearch.test.telemetry.tracing; |
| 10 | + |
| 11 | +import java.util.HashMap; |
| 12 | +import java.util.Map; |
| 13 | +import java.util.Random; |
| 14 | +import java.util.concurrent.ThreadLocalRandom; |
| 15 | +import java.util.function.Supplier; |
| 16 | +import org.opensearch.telemetry.tracing.AbstractSpan; |
| 17 | +import org.opensearch.telemetry.tracing.Span; |
| 18 | + |
| 19 | +/** |
| 20 | + * MockSpan for testing and strict check validations. Not to be used for production cases. |
| 21 | + */ |
| 22 | +public class MockSpan extends AbstractSpan { |
| 23 | + private final SpanProcessor spanProcessor; |
| 24 | + private final Map<String, Object> metadata; |
| 25 | + private final String traceId; |
| 26 | + private final String spanId; |
| 27 | + private boolean hasEnded; |
| 28 | + private final Long startTime; |
| 29 | + private Long endTime; |
| 30 | + |
| 31 | + private final Object lock = new Object(); |
| 32 | + |
| 33 | + private static final Supplier<Random> randomSupplier = ThreadLocalRandom::current; |
| 34 | + |
| 35 | + /** |
| 36 | + * Base Constructor. |
| 37 | + * @param spanName span name |
| 38 | + * @param parentSpan parent span |
| 39 | + * @param spanProcessor span processor |
| 40 | + */ |
| 41 | + public MockSpan(String spanName, Span parentSpan, SpanProcessor spanProcessor) { |
| 42 | + this( |
| 43 | + spanName, |
| 44 | + parentSpan, |
| 45 | + parentSpan != null ? parentSpan.getTraceId() : IdGenerator.generateTraceId(), |
| 46 | + IdGenerator.generateSpanId(), |
| 47 | + spanProcessor |
| 48 | + ); |
| 49 | + } |
| 50 | + |
| 51 | + /** |
| 52 | + * Constructor with traceId and SpanIds |
| 53 | + * @param spanName Span Name |
| 54 | + * @param parentSpan Parent Span |
| 55 | + * @param traceId Trace ID |
| 56 | + * @param spanId Span ID |
| 57 | + * @param spanProcessor Span Processor |
| 58 | + */ |
| 59 | + public MockSpan(String spanName, Span parentSpan, String traceId, String spanId, SpanProcessor spanProcessor) { |
| 60 | + super(spanName, parentSpan); |
| 61 | + this.spanProcessor = spanProcessor; |
| 62 | + this.metadata = new HashMap<>(); |
| 63 | + this.traceId = traceId; |
| 64 | + this.spanId = spanId; |
| 65 | + this.startTime = System.nanoTime(); |
| 66 | + } |
| 67 | + |
| 68 | + @Override |
| 69 | + public void endSpan() { |
| 70 | + synchronized (lock) { |
| 71 | + if (hasEnded) { |
| 72 | + return; |
| 73 | + } |
| 74 | + endTime = System.nanoTime(); |
| 75 | + hasEnded = true; |
| 76 | + } |
| 77 | + spanProcessor.onEnd(this); |
| 78 | + } |
| 79 | + |
| 80 | + @Override |
| 81 | + public void addAttribute(String key, String value) { |
| 82 | + putMetadata(key, value); |
| 83 | + } |
| 84 | + |
| 85 | + @Override |
| 86 | + public void addAttribute(String key, Long value) { |
| 87 | + putMetadata(key, value); |
| 88 | + } |
| 89 | + |
| 90 | + @Override |
| 91 | + public void addAttribute(String key, Double value) { |
| 92 | + putMetadata(key, value); |
| 93 | + } |
| 94 | + |
| 95 | + @Override |
| 96 | + public void addAttribute(String key, Boolean value) { |
| 97 | + putMetadata(key, value); |
| 98 | + } |
| 99 | + |
| 100 | + @Override |
| 101 | + public void addEvent(String event) { |
| 102 | + putMetadata(event, null); |
| 103 | + } |
| 104 | + |
| 105 | + private void putMetadata(String key, Object value) { |
| 106 | + metadata.put(key, value); |
| 107 | + } |
| 108 | + |
| 109 | + @Override |
| 110 | + public String getTraceId() { |
| 111 | + return traceId; |
| 112 | + } |
| 113 | + |
| 114 | + @Override |
| 115 | + public String getSpanId() { |
| 116 | + return spanId; |
| 117 | + } |
| 118 | + |
| 119 | + /** |
| 120 | + * Returns whether the span is ended or not. |
| 121 | + * @return span end status. |
| 122 | + */ |
| 123 | + public boolean hasEnded() { |
| 124 | + synchronized (lock) { |
| 125 | + return hasEnded; |
| 126 | + } |
| 127 | + } |
| 128 | + |
| 129 | + /** |
| 130 | + * Returns the start time of the span. |
| 131 | + * @return start time of the span. |
| 132 | + */ |
| 133 | + public Long getStartTime() { |
| 134 | + return startTime; |
| 135 | + } |
| 136 | + |
| 137 | + /** |
| 138 | + * Returns the start time of the span. |
| 139 | + * @return end time of the span. |
| 140 | + */ |
| 141 | + public Long getEndTime() { |
| 142 | + return endTime; |
| 143 | + } |
| 144 | + |
| 145 | + private static class IdGenerator { |
| 146 | + private static String generateSpanId() { |
| 147 | + long id = randomSupplier.get().nextLong(); |
| 148 | + return Long.toHexString(id); |
| 149 | + } |
| 150 | + |
| 151 | + private static String generateTraceId() { |
| 152 | + long idHi = randomSupplier.get().nextLong(); |
| 153 | + long idLo = randomSupplier.get().nextLong(); |
| 154 | + long result = idLo | (idHi << 32); |
| 155 | + return Long.toHexString(result); |
| 156 | + } |
| 157 | + |
| 158 | + } |
| 159 | +} |
0 commit comments