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

Study Backstage telemetry system #71

Closed
gorkem opened this issue Jan 11, 2023 · 10 comments
Closed

Study Backstage telemetry system #71

gorkem opened this issue Jan 11, 2023 · 10 comments

Comments

@gorkem
Copy link
Contributor

gorkem commented Jan 11, 2023

Goal
Study how backstage plugin analytics work. Discuss how it can be integrated with Red Hat telemetry collection.

Study how to enable telemetry in general on an instance of Backstage.

Acceptance criteria

  • The knowledge of plugging analytics mechanics present at the team.
  • Create a document that explains how Red Hat telemetry can be enabled for a plugin.
  • Create a document that explains how telemetry collection be enabled in a Backstage instance.
@christophe-f
Copy link
Contributor

Video from BackstageCon 2022: https://youtu.be/DtGV2zR2z6Y

@rtaniwa
Copy link

rtaniwa commented Jan 19, 2023

They also did a blog post with some additional details that might be helpful.

@cooktheryan
Copy link

@sallyom could be super helpful here

@invincibleJai
Copy link
Member

@tumido
Copy link
Member

tumido commented Nov 21, 2023

It is still valid. We do not document or provide a way to hook into RH telemetry.

We discussed a related topic and segued into this yesterday actually:

https://redhat.enterprise.slack.com/archives/C04CUSD4JSG/p1700249071832159?thread_ts=1700249071.832159&cid=C04CUSD4JSG

@kadel
Copy link
Member

kadel commented Nov 22, 2023

Yes, we will revisit this for the next milestone.

@tumido
Copy link
Member

tumido commented Nov 22, 2023

FTR for 1.0 we decided to remove the Segment plugin from the instance.

@christophe-f
Copy link
Contributor

Everything was done from this epic expect the documentation part that is planned next week.

@tumido
Copy link
Member

tumido commented Nov 23, 2023

FRT based on @christophe-f 's input this plugin is being added again as a dynamic plugin janus-idp/backstage-showcase#812

jkilzi pushed a commit to jkilzi/janus-idp-backstage-plugins that referenced this issue Jan 12, 2024
jkilzi pushed a commit to jkilzi/janus-idp-backstage-plugins that referenced this issue Jan 16, 2024
openshift-merge-bot bot pushed a commit that referenced this issue Jan 17, 2024
* feat(orchestrator): add orchestrator plugins

Squashed and rebased. Credits to
- Guilherme Caponetto
- Tiago Dolphine
- Michael Anstis

who did the work before squash and rebase.

* feat(orchestrator): enable dynamic plugin

* fix(orchestrator): load HostDirectory from backend-app-api (#28)

Signed-off-by: Moti Asayag <[email protected]>
(cherry picked from commit 3ba02c6)

* fix(orchestrator): make the port config optional (#38)

* feat(orchestrator): handle assessment workflow and make optional the workflowsSource config (#35)

* feat: issue FLPATH-591 - Add assessment workflow type and display outputs (#21)

* Configure for assessment swf

* filter assessment on workflow definition page

* workflow columns

* workflow columns

* workflow columns

* workflow filter

* feat: Render assessment results supporting dynamic categories

* issue FLPATH-657: workflow label

* Revert "Configure for assessment swf"

This reverts commit b4048e1.

* Revert sonata service port

* Add key for workflow options category

* Fix workflow execution from choose btn

* Fix review comments

* address comments

* Fix review comment to switch to useRouteRef

* fix review comments

* fix review comments

---------

Co-authored-by: richardwang98 <[email protected]>

* feat: make optional the workflowsSource config (#25)

---------

Co-authored-by: anludke <[email protected]>

* feat(orchestrator): add backend endpoint for getting workflows from data index service (#39)

* feat: add backend for getting work flows from data index service

* feat: cherrypick - add backend for getting work flows from data index service

* feat: cherrypick - add backend for getting work flows from data index service

* feat: cherrypick - add backend for getting work flows from data index service

* chore(orchestrator): update dependencies

* feat(orchestrator): orchestrator plugin entry page & workflows table (#31)

https://issues.redhat.com/browse/FLPATH-686
https://issues.redhat.com/browse/FLPATH-682

* feat: introduced the workflows/overview endpoint (#36)

* FLPATH-702 : New endpoint to fetch workflow overview

* FLPATH-702 : iterate through all elements instead of picking the first element

* modified the map method

* calculate avg execution time change

* Add log message when http calls failing

* Fix lint issues

* rename variable

* paginated graphql object fetch

* Include workflowId in the result object

* Renamed to description

* to epoc timestamp

* suppress eslint warning

* epoc number to string

* make all string fields optional

* use a simple for loop

* extracted to a new method

* rename to lastTriggeredMs

* include uri in the WorkflowOverview type

* mark avgDurationMs as optional

* feat(orchestrator): introduced `workflows/:workflowId/overview` endpoint (#40)

* FLPATH-702 : New endpoint to fetch workflow overview

* FLPATH-702 : iterate through all elements instead of picking the first element

* modified the map method

* calculate avg execution time change

* Add log message when http calls failing

* Fix lint issues

* rename variable

* paginated graphql object fetch

* Include workflowId in the result object

* Renamed to description

* to epoc timestamp

* suppress eslint warning

* epoc number to string

* make all string fields optional

* use a simple for loop

* extracted to a new method

* rename to lastTriggeredMs

* include uri in the WorkflowOverview type

* mark avgDurationMs as optional

* fetch only one overview obj

* fix(orchestrator): make the port config optional (#37)

* feat(orchestrator): orchestrator plugin entry page & workflows table (#31)

https://issues.redhat.com/browse/FLPATH-686
https://issues.redhat.com/browse/FLPATH-682

* removed unnecessary method

---------

Co-authored-by: Guilherme Caponetto <[email protected]>
Co-authored-by: Jonathan Kilzi <[email protected]>

* feat(orchestrator): add Workflow Run List  (#30)

* feat(orchestrator): add Workflow Run List

FLPATH-693

A component listing running workflows is added.

* chore: move loading logic out of the OrchestratorPage

* chore(orchestrator): implement the WorkflowViewerFormatter (#41)

* chore: implement the WorkflowViewerFormatter: utility for converting WorkflowOverview backend data to data UI can display

* removed redundant export and removed redundant 'Interface' suffix from DataFormatter interface name

* Update plugins/orchestrator/src/dataFormatters/DataFormatter.ts

Co-authored-by: Guilherme Caponetto <[email protected]>

---------

Co-authored-by: Guilherme Caponetto <[email protected]>

* feat(orchestrator): fetch data input schema from `/management/processes` (#45)

* Fetch data input schema from /management/processes

* Fix some code smells

* Rename WorkflowProcess -> WorkflowInfo

* feat(orchestrator): implement the workflow viewer new UX (#32)

* feat(orechestrator): implement the workflow viewer new UX

* code review fixes

* visual fixes including skeleton for loading state

* chore(orchestrator): Renames the components displaying the tabs content

* chore(orchestrator): updates the OrchestratorClient

Lazy loads the baseUrl
Adds a method for calling GET /workflows/overview

* feat(orchestrator): orchestrator workflow execution page (#46)

Co-authored-by: Jonathan Kilzi <[email protected]>

* chore(orchestrator): updates the stories grouping (#50)

* chore(orchestrator): aligns the workflows table with the design (#51)

* chore(orchestrator): add Category to the procesInstance result (#52)

* fix(orchestrator): add links to workflows in the workflow list (#53)

* feat: added color icon to workflow details page last run status field (#55)

* feat(orchestrator): enable usage of local envelope for the workflow editor (#56)

* feat(orchestrator): add business key to assessment and pass on to workflow options (#42)

* feat(orchestrator): add page listing details of a workflow run (#49)

* feat(orchestrator): add feature flag for developer mode and config to enable/disable the integration with catalog (#58)

* feat(orchestrator): workflow editor modal (#59)

* feat(orchestrator): fix missing workflow type in overview (#60)

Signed-off-by: Gloria Ciavarrini <[email protected]>

* fix(orchestrator): fix some code smells (#63)

* fix(orchestrator): addresses sonarcloud issues (#65)

* fix(orchestrator): addressed a couple of issues (#64)

* fix(orchestrator): minor fixes (#67)

* feat(orchestrator): refactoring to use data-index to fetch workflow definitions (#57)

Co-authored-by: Guilherme Caponetto <[email protected]>

* fix(orchestrator): fix sonar issue (#69)

* feat(orchestrator): use assessment process id as bk for next workflows (#70)

* feat(orchestrator): execute workflow page new UX (#68)

* fix(orchestrator): theme for `monaco-editor` in `JsonTextAreaForm` component and mandatory `dataIndexService.url` (#71)

* fix(orchestrator): remove dependency on devmode in the entity provider (#72)

* fix(orchestrator): skip it if hardcoded specs do not exist (#74)

* feat(orchestrator): execute workflow page polishing (#75)

* feat(orchestrator): workflow instance result page (#73)

* chore(orchestrator): add codeowners to orchestrator

* fix(FLPATH-852): show WF description on the execution result page (#77)

* chore(orchestrator): add OWNERS file to each orchestrator package

* feat(orchestrator): migrates to the new UI (#78)

---------

Signed-off-by: Gloria Ciavarrini <[email protected]>
Co-authored-by: Moti Asayag <[email protected]>
Co-authored-by: richard wang <[email protected]>
Co-authored-by: anludke <[email protected]>
Co-authored-by: rhkp <[email protected]>
Co-authored-by: Jonathan Kilzi <[email protected]>
Co-authored-by: Jude Niroshan <[email protected]>
Co-authored-by: Marek Libra <[email protected]>
Co-authored-by: Bat-Zion Rotman <[email protected]>
Co-authored-by: yu zhao <[email protected]>
Co-authored-by: Gloria Ciavarrini <[email protected]>
Co-authored-by: Tiago Dolphine <[email protected]>
@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Sep 3, 2024

This issue has been closed due to the fact that the Janus community is being sunset.

For future plugin issues, please use https://github.com/backstage/community-plugins/issues

For future showcase issues, please use https://issues.redhat.com/browse/RHIDP

For more information on the sunset, see:

https://janus-idp.io/blog/2024/07/05/future-of-janus-community
https://issues.redhat.com/browse/RHIDP-3690
https://issues.redhat.com/browse/RHIDP-1018

@rhdh-bot rhdh-bot closed this as completed Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants