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.

Sign up for GitHub

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

Jump to bottom

HPCC-32531 Document BareMetal Logaccess config #19064

Merged
merged 1 commit into from
Sep 30, 2024
Merged

HPCC-32531 Document BareMetal Logaccess config #19064

merged 1 commit into from
Sep 30, 2024

Conversation

rpastrana
Copy link
Member

@rpastrana rpastrana commented Aug 30, 2024 •
edited
Loading

  • Adds baremetal section to logaccess README
  • Adds new xml sample fle

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@github-actions GitHub Actions
Copy link

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-32531

Jirabot Action Result:
Assigning user: [email protected]
Workflow Transition To: Merge Pending
Updated PR

@rpastrana rpastrana requested a review from g-pan September 25, 2024 14:43
@rpastrana
Copy link
Member Author

@g-pan please look over README file changes

g-pan
g-pan reviewed Sep 26, 2024
View reviewed changes
Copy link
Member

@g-pan g-pan left a comment

Choose a reason for hiding this comment

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

one minor comment

helm/managed/logging/loki-stack/README.md Outdated
@@ -200,3 +200,24 @@ Example use:
logFormat:
type: "json"
```
#### Baremetal configuration

LogAccess can be configured on baremetal systems as well. It is not a common scenario because baremetal logs continue to be persisted on the local filesystem. Enabling LogAccess on a baremetal system would allow users to fetch remotely stored HPCC logs (not likely related to the host HPCC Systems deployment). To enable, inject a logAccess block with all configuration values properly filled in. The can be injected within the Sofware element in the active environment.xml or within the global element on the esp.xml.
Copy link
Member

Choose a reason for hiding this comment

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

The can be injected --
s/b "This" or possibly "The block"

Copy link
Member

Choose a reason for hiding this comment

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

also Sofware s/b software

@rpastrana
HPCC-32699 Encode all ALA response data
66cdf5c 
- Encodes all response log data from ALA

Signed-off-by: Rodrigo Pastrana <[email protected]>
@rpastrana rpastrana force-pushed the HPCC-32531DocumentBMLogaccessConfig branch from db7cc07 to 66cdf5c Compare September 26, 2024 19:27
@rpastrana
Copy link
Member Author

thanks @g-pan. Changes made and squashed, please confirm.

@rpastrana rpastrana requested a review from g-pan September 26, 2024 19:29
g-pan
g-pan approved these changes Sep 26, 2024
View reviewed changes
Copy link
Member

@g-pan g-pan left a comment

Choose a reason for hiding this comment

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

approved

@rpastrana
Copy link
Member Author

@ghalliday please merge

@ghalliday ghalliday merged commit 1a2a7bf into hpcc-systems:candidate-9.6.x Sep 30, 2024
52 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@g-pan g-pan g-pan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rpastrana @g-pan @ghalliday