Rename `BanyanDB.ShardingKey` to `BanyanDB.SeriesID` (#10037)

docs/en/changes/changes.md

@@ -134,6 +134,7 @@
 * Internal API: remove undocumented ElasticSearch API usage and use documented one.
 * Fix `BanyanDB.ShardingKey` annotation missed in the generated OAL metrics classes.
 * Fix Elasticsearch storage: Query `sortMetrics` missing transform real index column name.
+* Rename `BanyanDB.ShardingKey` to `BanyanDB.SeriesID`.
 
 #### UI
 

oap-server/oal-rt/src/main/java/org/apache/skywalking/oal/rt/OALRuntime.java

@@ -270,8 +270,8 @@ public class OALRuntime implements OALEngine {
                 }
                 annotationsAttribute.addAnnotation(columnAnnotation);
                 if (field.isID()) {
-                    // Add shardingKeyIdx = 0 to column annotation.
-                    Annotation banyanShardingKeyAnnotation = new Annotation(BanyanDB.ShardingKey.class.getName(), constPool);
+                    // Add SeriesID = 0 annotation to ID field.
+                    Annotation banyanShardingKeyAnnotation = new Annotation(BanyanDB.SeriesID.class.getName(), constPool);
                     banyanShardingKeyAnnotation.addMemberValue("index", new IntegerMemberValue(constPool, 0));
                     annotationsAttribute.addAnnotation(banyanShardingKeyAnnotation);
                 }

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/alarm/AlarmRecord.java

@@ -68,7 +68,7 @@ public class AlarmRecord extends Record {
     @Column(columnName = NAME, storageOnly = true, length = 512)
     private String name;
     @Column(columnName = ID0, storageOnly = true, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String id0;
     @Column(columnName = ID1, storageOnly = true)
     private String id1;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/log/AbstractLogRecord.java

@@ -51,13 +51,13 @@ public abstract class AbstractLogRecord extends Record {
     @Setter
     @Getter
     @Column(columnName = SERVICE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     @SQLDatabase.AdditionalEntity(additionalTables = {ADDITIONAL_TAG_TABLE}, reserveOriginalColumns = true)
     private String serviceId;
     @Setter
     @Getter
     @Column(columnName = SERVICE_INSTANCE_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 1)
+    @BanyanDB.SeriesID(index = 1)
     private String serviceInstanceId;
     @Setter
     @Getter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/networkalias/NetworkAddressAlias.java

@@ -56,7 +56,7 @@ public class NetworkAddressAlias extends Metrics {
     @Setter
     @Getter
     @Column(columnName = ADDRESS)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String address;
     @Setter
     @Getter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/relation/endpoint/EndpointRelationServerSideMetrics.java

@@ -66,7 +66,7 @@ public class EndpointRelationServerSideMetrics extends Metrics {
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
 
     @Override

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/relation/instance/ServiceInstanceRelationServerSideMetrics.java

@@ -76,7 +76,7 @@ public class ServiceInstanceRelationServerSideMetrics extends Metrics {
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
 
     @Override

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/relation/service/ServiceRelationServerSideMetrics.java

@@ -66,7 +66,7 @@ public class ServiceRelationServerSideMetrics extends Metrics {
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
 
     @Override

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/segment/SegmentRecord.java

@@ -70,13 +70,13 @@ public class SegmentRecord extends Record {
     @Setter
     @Getter
     @Column(columnName = SERVICE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     @SQLDatabase.AdditionalEntity(additionalTables = {ADDITIONAL_TAG_TABLE}, reserveOriginalColumns = true)
     private String serviceId;
     @Setter
     @Getter
     @Column(columnName = SERVICE_INSTANCE_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 1)
+    @BanyanDB.SeriesID(index = 1)
     private String serviceInstanceId;
     @Setter
     @Getter
@@ -93,7 +93,7 @@ public class SegmentRecord extends Record {
     @Setter
     @Getter
     @Column(columnName = IS_ERROR)
-    @BanyanDB.ShardingKey(index = 2)
+    @BanyanDB.SeriesID(index = 2)
     private int isError;
     @Setter
     @Getter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/spanattach/SpanAttachedEventRecord.java

@@ -66,7 +66,7 @@ public class SpanAttachedEventRecord extends Record {
     @Column(columnName = TRACE_REF_TYPE)
     private int traceRefType;
     @Column(columnName = TRACE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String traceId;
     @Column(columnName = TRACE_SEGMENT_ID)
     private String traceSegmentId;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/trace/SampledSlowTraceRecord.java

@@ -54,7 +54,7 @@ public class SampledSlowTraceRecord extends Record {
     @Column(columnName = ENTITY_ID)
     private String entityId;
     @Column(columnName = TRACE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String traceId;
     @Column(columnName = URI, storageOnly = true)
     private String uri;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/trace/SampledStatus4xxTraceRecord.java

@@ -55,7 +55,7 @@ public class SampledStatus4xxTraceRecord extends Record {
     @Column(columnName = ENTITY_ID)
     private String entityId;
     @Column(columnName = TRACE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String traceId;
     @Column(columnName = URI, storageOnly = true)
     private String uri;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/trace/SampledStatus5xxTraceRecord.java

@@ -55,7 +55,7 @@ public class SampledStatus5xxTraceRecord extends Record {
     @Column(columnName = ENTITY_ID)
     private String entityId;
     @Column(columnName = TRACE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String traceId;
     @Column(columnName = URI, storageOnly = true)
     private String uri;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/HistogramFunction.java

@@ -50,7 +50,7 @@ public abstract class HistogramFunction extends Meter implements AcceptableValue
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
     @Getter
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/PercentileFunction.java

@@ -58,7 +58,7 @@ public abstract class PercentileFunction extends Meter implements AcceptableValu
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
     @Getter
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/avg/AvgFunction.java

@@ -52,7 +52,7 @@ public abstract class AvgFunction extends Meter implements AcceptableValue<Long>
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
 
     /**

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/avg/AvgHistogramFunction.java

@@ -62,7 +62,7 @@ public abstract class AvgHistogramFunction extends Meter implements AcceptableVa
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
     @Getter
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/avg/AvgHistogramPercentileFunction.java

@@ -77,7 +77,7 @@ public abstract class AvgHistogramPercentileFunction extends Meter implements Ac
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
     @Getter
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/avg/AvgLabeledFunction.java

@@ -51,7 +51,7 @@ public abstract class AvgLabeledFunction extends Meter implements AcceptableValu
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
 
     /**

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/latest/LatestFunction.java

@@ -49,7 +49,7 @@ public abstract class LatestFunction extends Meter implements AcceptableValue<Lo
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
 
     /**

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/sum/SumFunction.java

@@ -49,7 +49,7 @@ public abstract class SumFunction extends Meter implements AcceptableValue<Long>
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
 
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/sum/SumHistogramPercentileFunction.java

@@ -68,7 +68,7 @@ public abstract class SumHistogramPercentileFunction extends Meter implements Ac
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
     @Getter
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/sumpermin/SumPerMinFunction.java

@@ -51,7 +51,7 @@ public abstract class SumPerMinFunction extends Meter implements AcceptableValue
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
 
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/meter/function/sumpermin/SumPerMinLabeledFunction.java

@@ -50,7 +50,7 @@ public abstract class SumPerMinLabeledFunction extends Meter implements Acceptab
     @Setter
     @Getter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
 
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/topn/TopN.java

@@ -46,7 +46,7 @@ public abstract class TopN extends Record implements ComparableStorageData {
     @Getter
     @Setter
     @Column(columnName = ENTITY_ID, length = 512)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String entityId;
     @Getter
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/browser/manual/errorlog/BrowserErrorLogRecord.java

@@ -62,7 +62,7 @@ public class BrowserErrorLogRecord extends Record {
     @Setter
     @Getter
     @Column(columnName = SERVICE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String serviceId;
 
     @Setter

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/profiling/ebpf/storage/EBPFProfilingDataRecord.java

@@ -50,7 +50,7 @@ public class EBPFProfilingDataRecord extends Record {
     public static final String UPLOAD_TIME = "upload_time";
 
     @Column(columnName = TASK_ID, length = 600)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String taskId;
     @Column(columnName = SCHEDULE_ID, length = 600)
     private String scheduleId;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/profiling/ebpf/storage/EBPFProfilingTaskRecord.java

@@ -61,7 +61,7 @@ public class EBPFProfilingTaskRecord extends NoneStream {
     @Column(columnName = LOGICAL_ID)
     private String logicalId;
     @Column(columnName = SERVICE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String serviceId;
     @Column(columnName = PROCESS_LABELS_JSON, length = PROCESS_LABELS_JSON_MAX_LENGTH)
     private String processLabelsJson;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/profiling/trace/ProfileTaskLogRecord.java

@@ -53,7 +53,7 @@ public class ProfileTaskLogRecord extends Record {
     @Column(columnName = TASK_ID)
     private String taskId;
     @Column(columnName = INSTANCE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String instanceId;
     @Column(columnName = OPERATION_TYPE, storageOnly = true)
     private int operationType;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/profiling/trace/ProfileTaskRecord.java

@@ -59,7 +59,7 @@ public class ProfileTaskRecord extends NoneStream {
     }
 
     @Column(columnName = SERVICE_ID)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String serviceId;
     @Column(columnName = ENDPOINT_NAME, length = 512)
     private String endpointName;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/profiling/trace/ProfileThreadSnapshotRecord.java

@@ -57,7 +57,7 @@ public class ProfileThreadSnapshotRecord extends Record {
     @Column(columnName = SEGMENT_ID)
     @SQLDatabase.QueryUnifiedIndex(withColumns = {SEQUENCE})
     @SQLDatabase.QueryUnifiedIndex(withColumns = {DUMP_TIME})
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String segmentId;
     @Column(columnName = DUMP_TIME)
     private long dumpTime;

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/storage/annotation/BanyanDB.java

@@ -46,8 +46,8 @@ public @interface BanyanDB {
     }
 
     /**
-     * Sharding key is used to group time series data per metric of one entity in one place (same sharding and/or same
-     * row for column-oriented database).
+     * Series key is used to group time series data per metric of one entity in one place.
+     *
      * For example,
      * ServiceA's traffic gauge, service call per minute, includes following timestamp values, then it should be sharded
      * by service ID
@@ -66,12 +66,13 @@ public @interface BanyanDB {
      * Only work with {@link Column}
      *
      * @return non-negative if this column be used for sharding. -1 means not as a sharding key
+     * @since 9.3.0 Rename as SeriesID.
      * @since 9.1.0 created as a new annotation.
      * @since 9.0.0 added in {@link Column}
      */
     @Target({ElementType.FIELD})
     @Retention(RetentionPolicy.RUNTIME)
-    @interface ShardingKey {
+    @interface SeriesID {
         /**
          * Relative entity tag
          *

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/storage/model/BanyanDBExtension.java

@@ -31,7 +31,7 @@ import org.apache.skywalking.oap.server.core.storage.annotation.BanyanDB;
 public class BanyanDBExtension {
     /**
      * Sharding key is used to group time series data per metric of one entity. See {@link
-     * BanyanDB.ShardingKey#index()}.
+     * BanyanDB.SeriesID#index()}.
      *
      * @since 9.1.0 moved into BanyanDBExtension
      * @since 9.0.0 added into {@link ModelColumn}

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/storage/model/StorageModels.java

@@ -191,8 +191,8 @@ public class StorageModels implements IModelManager, ModelCreator, ModelManipula
                 );
 
                 // BanyanDB extension
-                final BanyanDB.ShardingKey banyanDBShardingKey = field.getAnnotation(
-                    BanyanDB.ShardingKey.class);
+                final BanyanDB.SeriesID banyanDBSeriesID = field.getAnnotation(
+                    BanyanDB.SeriesID.class);
                 final BanyanDB.GlobalIndex banyanDBGlobalIndex = field.getAnnotation(
                     BanyanDB.GlobalIndex.class);
                 final BanyanDB.NoIndexing banyanDBNoIndex = field.getAnnotation(
@@ -200,7 +200,7 @@ public class StorageModels implements IModelManager, ModelCreator, ModelManipula
                 final BanyanDB.IndexRule banyanDBIndexRule = field.getAnnotation(
                         BanyanDB.IndexRule.class);
                 BanyanDBExtension banyanDBExtension = new BanyanDBExtension(
-                    banyanDBShardingKey == null ? -1 : banyanDBShardingKey.index(),
+                    banyanDBSeriesID == null ? -1 : banyanDBSeriesID.index(),
                     banyanDBGlobalIndex != null,
                     banyanDBNoIndex == null && column.storageOnly(),
                     banyanDBIndexRule == null ? BanyanDB.IndexRule.IndexType.INVERTED : banyanDBIndexRule.indexType()

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/zipkin/ZipkinSpanRecord.java

@@ -114,7 +114,7 @@ public class ZipkinSpanRecord extends Record {
     @Setter
     @Getter
     @Column(columnName = LOCAL_ENDPOINT_SERVICE_NAME)
-    @BanyanDB.ShardingKey(index = 0)
+    @BanyanDB.SeriesID(index = 0)
     private String localEndpointServiceName;
     @Setter
     @Getter