Skip to content

Commit 546fa54

Browse files
authored
Update index mode document (#75)
* [maven-release-plugin] prepare release 0.8.0-rc0 * Update index mode doc Signed-off-by: Gao Hongtao <[email protected]> --------- Signed-off-by: Gao Hongtao <[email protected]>
1 parent 0c0d2df commit 546fa54

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,33 @@ Measure m = Measure.newBuilder()
206206
client.define(m);
207207
```
208208

209+
If you want to create an `index_mode` `Measure`:
210+
211+
```java
212+
Measure m = Measure.newBuilder()
213+
.setMetadata(Metadata.newBuilder()
214+
.setGroup("sw_metric")
215+
.setName("service_traffic"))
216+
.setEntity(Entity.newBuilder().addTagNames("service_id"))
217+
.setIndexMode(true)
218+
.addTagFamilies(
219+
TagFamilySpec.newBuilder()
220+
.setName("default")
221+
.addTags(
222+
TagSpec.newBuilder()
223+
.setName("service_id")
224+
.setType(
225+
TagType.TAG_TYPE_STRING))
226+
.addTags(
227+
TagSpec.newBuilder()
228+
.setName("layer")
229+
.setType(
230+
TagType.TAG_TYPE_STRING)))
231+
.build();
232+
// define a "index_mode" measure, as we've mentioned above
233+
client.define(m);
234+
```
235+
209236
For more APIs usage, refer to test cases and API docs.
210237

211238
## Query

0 commit comments

Comments
 (0)