Update readme.md with moesif implementation instructions and configs#150
Update readme.md with moesif implementation instructions and configs#150
Conversation
WalkthroughDocumentation and a sample config were updated to add explicit publishing workflows for OpenSearch and Moesif dashboards; README reorganized into stepwise sections and a new publisher field was added to the sample TOML, resulting in an additional analytics block. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant FHIR_Service as FHIR Service
participant Interceptor as AnalyticsResponseInterceptor
participant Publisher as Publisher Dispatcher
participant OpenSearch as OpenSearch
participant Moesif as Moesif
Client->>FHIR_Service: API request/response
FHIR_Service->>Interceptor: emit analytics event (includes x-jwt-assertion)
Interceptor->>Publisher: enqueue/publish event (reads Config.toml publisher)
alt publisher == "opensearch"
Publisher->>OpenSearch: bulk index events (async)
OpenSearch-->>Publisher: ack / error
else publisher == "moesif"
Publisher->>Moesif: send batched events (HTTP)
Moesif-->>Publisher: ack / error
end
Publisher-->>Interceptor: publish status
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
fhir-service/resources/analytics_sample_config.toml (1)
1-50: Remove duplicate TOML table header[ballerinax.health.fhirr4.analytics].The configuration has conflicting definitions: lines 1–13 define the original
[ballerinax.health.fhirr4.analytics]block with OpenSearch credentials, and lines 17–20 redefine the same table with only apublisherfield. In TOML, redefining a table header invalidates the first definition or causes a parse error. The refactoring should consolidate these into a single, coherent analytics block with the publisher field, moving OpenSearch-specific credentials to[ballerinax.health.fhirr4.openSearch].Apply this diff to fix the TOML structure:
-# Sample configuration for Patient Access API Metrics with FHIR R4 Analytics -[ballerinax.health.fhirr4.analytics] -enabled = true -attributes = ["fhirUser", "client_id", "iss"] -url = "http://localhost:9200/patient_access/_doc" # Opensearch format: <hostname>/<index>/_doc -username = "admin" -password = "Strong@pass@432" - -[ballerinax.health.fhirr4.analytics.moreInfo] -enabled = true -url = "http://localhost:8082/more_info" -username = "admin" -password = "MoreInfo@987" - - # Sample configuration for Patient Access API Metrics with FHIR R4 Analytics [ballerinax.health.fhirr4.analytics] enabled = true # Enable or disable analytics publishing attributes = ["fhirUser", "client_id", "iss"] publisher = "opensearch" # applicable values are either "moesif" or "opensearch"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
fhir-service/resources/analytics_README.md(3 hunks)fhir-service/resources/analytics_sample_config.toml(1 hunks)
🧰 Additional context used
🪛 LanguageTool
fhir-service/resources/analytics_README.md
[grammar] ~69-~69: Ensure spelling is correct
Context: ...Opensearch index fields will be created acording to the attributes sent in the first log...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~82-~82: Ensure spelling is correct
Context: ...esif application and copy the generated applicaiton ID. #### Step 2: Run the patient-acces...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~113-~113: Ensure spelling is correct
Context: ...abled. Once the job is started, all the pupublished data in the database will be published ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
fhir-service/resources/analytics_README.md
80-80: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🔇 Additional comments (1)
fhir-service/resources/analytics_README.md (1)
1-116: Documentation restructuring looks comprehensive.The README has been well-restructured to support both OpenSearch and Moesif dashboards. The documentation clearly separates configuration steps for each platform, provides sample configurations, and explains the dual-dashboard publishing workflow. The alignment with the configuration file changes (analytics publisher field selection) is logical and well-documented.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
fhir-service/resources/analytics_README.md (1)
1-115: Standardize capitalization of "OpenSearch" product name.The product name appears as both "Opensearch" (lowercase 's') and "OpenSearch" (capitalized 'S'). The official product name is "OpenSearch" with a capital 'S'. Standardizing this throughout improves professional presentation and clarity.
Search and replace instances to use consistent capitalization:
- Line 1, 40, 52, 75: Change "Opensearch" → "OpenSearch"
- Line 61: Change
open_search_dashboard_host→opensearch_dashboard_host(for consistency in variable naming)
| ### Sample Opensearch Dashboard for Patient Access API Metrics | ||
|  |
There was a problem hiding this comment.
🧩 Analysis chain
Verify image file exists and is properly referenced.
The image reference uses a relative path. Ensure the file analytics_sample_opensearch_dashboard.png exists in the same directory as this README, otherwise the image won't render in documentation viewers.
🏁 Script executed:
#!/bin/bash
# Description: Verify that the referenced image file and other auxiliary files exist.
# Check if image file exists
fd "analytics_sample_opensearch_dashboard.png" fhir-service/resources/
# List all files in the analytics resources directory to confirm structure
ls -la fhir-service/resources/ | grep -E "(analytics|opensearch|moesif)"Length of output: 584
---
🏁 Script executed:
```shell
#!/bin/bash
# Description: Check for capitalization inconsistency in "Opensearch" vs "OpenSearch"
# Search for both variants in the analytics_README.md file
echo "=== Searching for 'Opensearch' (lowercase 's') ==="
rg -n "Opensearch" fhir-service/resources/analytics_README.md
echo ""
echo "=== Searching for 'OpenSearch' (correct capitalization) ==="
rg -n "OpenSearch" fhir-service/resources/analytics_README.md
echo ""
echo "=== Product name in section headings and references ==="
rg -n "Sample (Opensearch|OpenSearch)" fhir-service/resources/analytics_README.md
Length of output: 2398
Verify image file and fix product name capitalization.
The image file analytics_sample_opensearch_dashboard.png exists and will render correctly. However, the product name capitalization is inconsistent throughout the document. The official product name is "OpenSearch" (capital 'S'), but most references use "Opensearch" (lowercase 's'). Update all instances of "Opensearch" to "OpenSearch" for consistency and accuracy—this includes line 75's subsection heading and 14+ other occurrences throughout the file.
🤖 Prompt for AI Agents
In fhir-service/resources/analytics_README.md around lines 75-76, the subsection
heading and many other occurrences use the incorrect product name capitalization
"Opensearch"; the image file analytics_sample_opensearch_dashboard.png is valid
and does not need change. Replace every instance of "Opensearch" (about 14+
occurrences) with the correct "OpenSearch" throughout the file (including the
subsection heading at line 75), and update any filenames or alt text only if
they intentionally reference the product name (leave the existing image filename
unchanged unless you choose to rename it consistently).
1 participant
Update readme.md with moesif implementation instructions and configs
Summary by CodeRabbit
Documentation
New Features