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

Write report marker #5385

Open
2 tasks done
brianehlert opened this issue Apr 12, 2024 · 1 comment · May be fixed by #6309
Open
2 tasks done

Write report marker #5385

brianehlert opened this issue Apr 12, 2024 · 1 comment · May be fixed by #6309
Assignees
Labels
backlog Pull requests/issues that are backlog items proposal An issue that proposes a feature request refined Issues that are ready to be prioritized
Milestone

Comments

@brianehlert
Copy link
Collaborator

brianehlert commented Apr 12, 2024

Overview

Write a simple txt file that contains name:value pairs of the following:

  • Integration - (string) (N1) this identifies the instance as part of a NIC or NGF (or other) integration.
  • ClusterID - (string) (per cluster) cluster relationship for the deployment.
  • ClusterNodeCount - (int) (per cluster & per node) the number of nodes in the cluster.
  • InstallationID - (string) (per instance) this identifies the individual NIC/NGF deployment relationship.

Output location: /etc/nginx/reporting/tracking.info

Acceptance Criteria

  • Output file is a simple text file
  • Must work with readOnlyRootFilesystem: true
  • Should be written near startup.
  • File is updated periodically updated. (once per 24 hours, for example)
  • Entry referencing file is defined in NGINX mgmt block

Data Format

File format is simple JSON-based format with these values supported:

{
    "Integration": "nic",
    "ClusterID": "6B29FC40-CA47-1067-B31D-00DD010662DA",
    "ClusterNodeCount": 5,
    "InstallationID": "6B29FC40-CA47-1067-B31D-00DD010662DB"
}

Tasks

@brianehlert brianehlert added proposal An issue that proposes a feature request backlog Pull requests/issues that are backlog items ready for refinement An issue that was triaged and it is ready to be refined labels Apr 12, 2024
@brianehlert brianehlert added this to the v3.6.0 milestone Apr 12, 2024
@vepatel
Copy link
Contributor

vepatel commented Apr 23, 2024

Integration:nic
ClusterID:6B29FC40-CA47-1067-B31D-SOMETHING
ClusterNodeCount:5
InstallationID:6B29FC40-CA47-1067-B31D-SOMETHING-ELSE

@brianehlert can you clarify if its going to be a ':' or '-' between the key/values?

@danielnginx danielnginx added refined Issues that are ready to be prioritized and removed ready for refinement An issue that was triaged and it is ready to be refined labels Apr 25, 2024
@shaun-nx shaun-nx modified the milestones: v3.6.0, Candidates Jul 8, 2024
@AlexFenlon AlexFenlon added the needs more info Issues that require more information label Aug 21, 2024
@shaun-nx shaun-nx removed the needs more info Issues that require more information label Aug 21, 2024
@j1m-ryan j1m-ryan self-assigned this Aug 22, 2024
@shaun-nx shaun-nx modified the milestones: Candidates, v3.8.0 Sep 17, 2024
@shaun-nx shaun-nx linked a pull request Sep 18, 2024 that will close this issue
6 tasks
@shaun-nx shaun-nx modified the milestones: v3.8.0, v4.0.0 Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Pull requests/issues that are backlog items proposal An issue that proposes a feature request refined Issues that are ready to be prioritized
Projects
Status: In Progress 🛠
Development

Successfully merging a pull request may close this issue.

6 participants