Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
smcvb committed Dec 12, 2024
2 parents ccb0400 + 5d873da commit 66e5bf9
Show file tree
Hide file tree
Showing 11 changed files with 37 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
uses: actions/checkout@v4

- name: Set up JDK ${{ matrix.java-version }}
uses: actions/setup-java@v4.4.0
uses: actions/setup-java@v4.5.0
with:
distribution: 'zulu'
java-version: ${{ matrix.java-version }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pullrequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
uses: actions/checkout@v4

- name: Set up JDK ${{ matrix.java-version }}
uses: actions/setup-java@v4.4.0
uses: actions/setup-java@v4.5.0
with:
distribution: 'zulu'
java-version: ${{ matrix.java-version }}
Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Documentation For Axon Framework - Tracing Extension.

This folder contains the docs related to the Tracing Extension for Axon Framework. The docs in this folder are written as part of the [AxonIQ Library](https://library.axoniq.io), and are [written in Ascii and built with Antora.](https://library.axoniq.io/contribution_guide/overview/platform.html)
This folder contains the docs related to the Tracing Extension for Axon Framework. The docs in this folder are written as part of the [AxonIQ Library](https://library.axoniq.io), and are [written in Ascii and built with Antora.](https://library.axoniq.io/contibution-guide/overview/platform.html)

The following are the current documentation sources (folders):

- `extension-guide` : [The Tracing Extension Guide](https://library.axoniq.io/tracing_extension_guide/index.html)
- `extension-guide` : [The Tracing Extension Guide](https://library.axoniq.io/tracing-extension-reference/index.html)

## Contributing to the docs.

You are welcome to contribute to these docs. Whether you want to fix a typo, or you find something missing, something that is not clear or can be improved, or even if you want to write an entire piece of docs to illustrate something that could help others to understand the use of the Bike Rental App, you are more than welcome to send a Pull Request to this GitHub repository. Just make sure you follow the guidelines explained in [AxonIQ Library Contribution Guide](https://library.axoniq.io/contribution_guide/index.html)
You are welcome to contribute to these docs. Whether you want to fix a typo, or you find something missing, something that is not clear or can be improved, or even if you want to write an entire piece of docs to illustrate something that could help others to understand the use of the Bike Rental App, you are more than welcome to send a Pull Request to this GitHub repository. Just make sure you follow the guidelines explained in [AxonIQ Library Contribution Guide](https://library.axoniq.io/contibution-guide/index.html)

## Building and testing these docs locally.

If you want to build and explore the docs locally (because you have made changes or before contributing), you can use the Antora's build file in `docs/_playbook` folder.

You can check the [detailed information on how the process to build the docs works](https://library.axoniq.io/contribution_guide/overview/build.html), but in short, all you have to do is:
You can check the [detailed information on how the process to build the docs works](https://library.axoniq.io/contibution-guide/overview/build.html), but in short, all you have to do is:

1. Make sure you have Node (a LTS version is preferred), Antora and Vale installed in your system.
2. CD to the `docs/_playbook` folder.
Expand Down
2 changes: 1 addition & 1 deletion docs/_playbook/playbook.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site:
title: Tracing Extension docs PREVIEW
start_page: tracing_extension_guide::index.adoc
start_page: tracing-extension-reference::index.adoc

content:
sources:
Expand Down
14 changes: 0 additions & 14 deletions docs/extension-guide/antora.yml

This file was deleted.

2 changes: 0 additions & 2 deletions docs/extension-guide/modules/nav.adoc

This file was deleted.

16 changes: 16 additions & 0 deletions docs/reference/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: tracing-extension-reference
title: Tracing Extension Guide
version:
axon-tracing-(?<version>+({0..9}).+({0..9})).*: $<version>
master: development
prerelease: true
start_page: ROOT:index.adoc

asciidoc:
attributes:
component_description: Extension adding OpenTracing integration to Axon's infrastructure components, superseded by integrated Open Telemetry support
type: extension-reference
group: axon-framework

nav:
- modules/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The extension can be disabled setting the property `axon.extension.tracing.enabl

Furthermore, there is a more fine-grained configuration option of the tracing span tags on commands, events and queries. You can customize span tags easily, mixing and matching between available tag `MESSAGE_ID`, `AGGREGATE_ID`, `MESSAGE_TYPE`, `PAYLOAD_TYPE`, `MESSAGE_NAME` and `PAYLOAD`. Take into account that some of the tags make sense on a certain span type, but not on another, and some of them have an hidden cost on network (such as payload). Use them wisely.

[sources,properties]
[source,properties]
----
axon.extension.tracing.span.commandTags=MESSAGE_ID, MESSAGE_TYPE, PAYLOAD_TYPE, MESSAGE_NAME
axon.extension.tracing.span.eventTags=MESSAGE_ID, AGGREGATE_ID, MESSAGE_TYPE, PAYLOAD_TYPE
Expand Down
11 changes: 11 additions & 0 deletions docs/reference/modules/ROOT/pages/release-notes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
= Release Notes Tracing Extension
:navtitle: Release notes

You can find the release notes for the Tracing Extension of version 4.10 below.
For earlier releases, please go to the link:https://legacydocs.axoniq.io/reference-guide/release-notes/rn-extensions/rn-tracing[legacy documentation].

== Release 4.10

Upgrades the Tracing Extension to be compatible with Axon Framework 4.10.0, and updates various dependencies.

See the link:https://github.com/AxonFramework/extension-tracing/releases/tag/axon-tracing-4.10.0[GitHub release notes] for an exhaustive list of all changes.
2 changes: 2 additions & 0 deletions docs/reference/modules/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* xref::config.adoc[]
* xref::release-notes.adoc[]

0 comments on commit 66e5bf9

Please sign in to comment.