Skip to content

Observability components related to the internal executions in Ballerina

License

Notifications You must be signed in to change notification settings

ballerina-platform/module-ballerinai-observe

Repository files navigation

Ballerina Observe Internal Library

Build Trivy GitHub Last Commit codecov

This module contains internal configurations and initializations for Ballerina observability. Ballerina supports observability out of the box. You can use module-ballerina-observe in your Ballerina project and enable the observability features.

Build from the source

Set Up the prerequisites

  1. Download and install Java SE Development Kit (JDK) version 21 (from one of the following locations).

    • Oracle

    • OpenJDK

      Note: Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.

  2. Export your GitHub Personal access token with read package permissions as follows.

     export packageUser=<Username>
     export packagePAT=<Personal access token>
    

Build the source

Execute the commands below to build from source.

  1. To build the library:

    ./gradlew clean build
    
  2. To run the integration tests:

    ./gradlew clean test
    
  3. To run a group of tests

    ./gradlew clean test -Pgroups=<test_group_names>
    
  4. To build the package without the tests:

    ./gradlew clean build -x test
    
  5. To debug the tests:

    ./gradlew clean test -Pdebug=<port>
    
  6. To debug with Ballerina language:

    ./gradlew clean build -PbalJavaDebug=<port>
    
  7. Publish the generated artifacts to the local Ballerina central repository:

    ./gradlew clean build -PpublishToLocalCentral=true
    
  8. Publish the generated artifacts to the Ballerina central repository:

    ./gradlew clean build -PpublishToCentral=true
    

Contribute to Ballerina

As an open source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All contributors are encouraged to read the Ballerina Code of Conduct.

Useful links