@@ -41,27 +40,23 @@ public class ServiceInstance extends Source {
}
```
3. The `scope()` method in Source, returns an ID, which is not a random number. This ID need to be declared through
`@ScopeDeclaration` annotation too. The ID in `@ScopeDeclaration` and ID in `scope()` method should be same for this Source.
3. The `scope()` method in source returns an ID, which is not a random value. This ID must be declared through the `@ScopeDeclaration` annotation too. The ID in `@ScopeDeclaration` and ID in `scope()` method must be the same for this source.
4. The `String getEntityId()` method in Source, requests the return value representing unique entity which the scope related.
Such as,
in this Service scope, the id is service id, representing a particular service, like `Order` service.
This value is used in [OAL group mechanism](../concepts-and-designs/oal.md#group).
4. The `String getEntityId()` method in source requests the return value representing the unique entity to which the scope relates. For example, in this service scope, the ID is the service ID, which represents a particular service, like the `Order` service.
This value is used in the [OAL group mechanism](../concepts-and-designs/oal.md#group).
5.`@ScopeDefaultColumn.VirtualColumnDefinition` and `@ScopeDefaultColumn.DefinedByField` are required, all declared fields(virtual/byField)
are going to be pushed into persistent entity, mapping to such as ElasticSearch index and Database table column.
Such as, include entity id mostly, and service id for endpoint and service instance level scope. Take a reference to all existing scopes.
All these fields are detected by OAL Runtime, and required in query stage.
5.`@ScopeDefaultColumn.VirtualColumnDefinition` and `@ScopeDefaultColumn.DefinedByField` are required. All declared fields (virtual/byField) will be pushed into a persistent entity, and maps to lists such as the ElasticSearch index and Database table column.
For example, the entity ID and service ID for endpoint and service instance level scope are usually included. Take a reference from all existing scopes.
All these fields are detected by OAL Runtime, and are required during query.
6. Add scope name as keyword to oal grammar definition file, `OALLexer.g4`, which is at `antlr4` folder of`generate-tool-grammar` module.
6. Add scope name as keyword to OAL grammar definition file, `OALLexer.g4`, which is at the `antlr4` folder of the`generate-tool-grammar` module.
7. Add scope name keyword as source in parser definition file, `OALParser.g4`, which is at same fold of`OALLexer.g4`.
7. Add scope name as keyword to the parser definition file, `OALParser.g4`, which is located in the same folder as`OALLexer.g4`.
___
After you done all of these, you could build a receiver, which do
1. Get the original data of the metrics,
1. Build the source, send into `SourceReceiver`.
1. Write your whole OAL scripts.
1. Repackage the project.
\ No newline at end of file
After finishing these steps, you could build a receiver, which do
1. Obtain the original data of the metrics.
1. Build the source, and send to `SourceReceiver`.