Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#244: Create the Info module #248

Merged
merged 12 commits into from
Aug 28, 2024
Merged

Conversation

benedeki
Copy link
Contributor

@benedeki benedeki commented Aug 19, 2024

  • created new module Atum-Info
  • the new modul added to JaCoco and CI routines

Closes #244

Release notes:

  • Introduced the Reader module to make reading of information stored in Atum server easy.

* created new module Info
* the new modul added to JaCoco and CI routines
Copy link

github-actions bot commented Aug 19, 2024

JaCoCo model module code coverage report - scala 2.13.11

Overall Project 63.64% 🍏

There is no coverage information present for the Files changed

Copy link

JaCoCo agent module code coverage report - scala 2.13.11

Overall Project 85.84% 🍏

There is no coverage information present for the Files changed

Copy link

github-actions bot commented Aug 19, 2024

JaCoCo server module code coverage report - scala 2.13.11

Overall Project 77.76% 🍏

There is no coverage information present for the Files changed

@benedeki
Copy link
Contributor Author

benedeki commented Aug 19, 2024

Release notes:
Introduced the Reader module to make reading of information stored in Atum server easy.


package za.co.absa.atum.info

class FLowInfo {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
class FLowInfo {
class FlowInfo {

build.sbt Outdated
* Module `info` is the library to be plugged into application which wants to easily read the measured data stored in the
* server
*/
lazy val info = (projectMatrix in file("info"))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the only thing is that I'm not sure about the name info; what about:

  • agent -> agent-publisher, metrics-publisher, measurement-publisher, measure-publisher, publisher, or something like that, possibly instead of publisher we can have: writer or producer ?
  • info -> agent-reader, metrics-reader, measurement-reader, measure-reader or reader or something like that, possibly instead of reader we can have: consumer or observer?

Copy link
Collaborator

@lsulak lsulak Aug 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

even a simple agent-publisher + agent-consumer or agent-writer + agent-reader can be a nice alternative

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's discuss the name on the team tech call.

Copy link
Contributor Author

@benedeki benedeki Aug 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We agreed on Reader (Atum-Reader)

@benedeki benedeki self-assigned this Aug 25, 2024
Copy link

github-actions bot commented Aug 26, 2024

JaCoCo reader module code coverage report - scala 2.13.11

Overall Project 100% 🍏
Files changed 100% 🍏

File Coverage
FlowReader.scala 100% 🍏
PartitioningReader.scala 100% 🍏

lsulak
lsulak previously approved these changes Aug 26, 2024
* JaCoCo exclusion for model
@@ -98,6 +109,8 @@ jobs:
run: |
echo "Total agent module coverage ${{ steps.jacoco-agent.outputs.coverage-overall }}"
echo "Changed Files coverage ${{ steps.jacoco-agent.outputs.coverage-changed-files }}"
echo "Total agent module coverage ${{ steps.jacoco-reader.outputs.coverage-overall }}"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong msg - this is about the reader coverage

Setup.commonSettings ++ Seq(
name := "atum-reader",
javacOptions ++= Setup.clientJavacOptions,
publish / skip := true // module is not yet finished, so we don't want to publish it
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there could be a ticket but I don't mind / insist

@benedeki benedeki merged commit b080a34 into master Aug 28, 2024
10 checks passed
@benedeki benedeki deleted the feature/244-create-the-Info-module branch August 28, 2024 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create the Info module
3 participants