https://github.com/redhatinsights/insights-results-aggregator

Aggregator service for insights results
https://github.com/redhatinsights/insights-results-aggregator

cache data-flow insights restapi service

Last synced: about 2 months ago
JSON representation

Aggregator service for insights results

• Host: GitHub
• URL: https://github.com/redhatinsights/insights-results-aggregator
• Owner: RedHatInsights
• License: apache-2.0
• Created: 2020-01-27T11:45:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-04-10T02:13:39.000Z (about 2 months ago)
• Last Synced: 2025-04-10T03:24:00.208Z (about 2 months ago)
• Topics: cache, data-flow, insights, restapi, service
• Language: Go
• Homepage: https://redhatinsights.github.io/insights-results-aggregator/
• Size: 14 MB
• Stars: 7
• Watchers: 8
• Forks: 24
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Insights Results Aggregator

[![forthebadge made-with-go](http://ForTheBadge.com/images/badges/made-with-go.svg)](https://go.dev/)

[![GoDoc](https://godoc.org/github.com/RedHatInsights/insights-results-aggregator?status.svg)](https://godoc.org/github.com/RedHatInsights/insights-results-aggregator)

[![GitHub Pages](https://img.shields.io/badge/%20-GitHub%20Pages-informational)](https://redhatinsights.github.io/insights-results-aggregator/)

[![Go Report Card](https://goreportcard.com/badge/github.com/RedHatInsights/insights-results-aggregator)](https://goreportcard.com/report/github.com/RedHatInsights/insights-results-aggregator)

[![Build Status](https://ci.ext.devshift.net/buildStatus/icon?job=RedHatInsights-insights-results-aggregator-gh-build-master)](https://ci.ext.devshift.net/job/RedHatInsights-insights-results-aggregator-gh-build-master/)

[![Build Status](https://travis-ci.org/RedHatInsights/insights-results-aggregator.svg?branch=master)](https://travis-ci.org/RedHatInsights/insights-results-aggregator)

[![codecov](https://codecov.io/gh/RedHatInsights/insights-results-aggregator/branch/master/graph/badge.svg)](https://codecov.io/gh/RedHatInsights/insights-results-aggregator)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/RedHatInsights/insights-results-aggregator)

[![License](https://img.shields.io/badge/license-Apache-blue)](https://github.com/RedHatInsights/insights-results-aggregator/blob/master/LICENSE)

Aggregator service for insights results

* [Description](#description)

* [Documentation](#documentation)

* [Makefile targets](#makefile-targets)

* [Usage](#usage)

* [BDD tests](#bdd-tests)

* [Package manifest](#package-manifest)

## Description

Insights Results Aggregator is a service that provides Insight OCP data

(officially called *recommendations*) that are being consumed by OpenShift

Cluster Manager (OCM), Advanced Cluster Manager (ACM), and OCP WebConsole via

Insights Operator. That data contain information about clusters status

(especially health, security, performance, etc.) and recommendations based on

results generated by Insights rules engine. Insights OCP data are consumed from

selected broker, stored in different storages (that basically work as a cache)

so we can expose it via REST API endpoints.

## Documentation

Documentation is hosted on Github Pages .

Sources are located in [docs](https://github.com/RedHatInsights/insights-results-aggregator/tree/master/docs).

## Makefile targets

```

clean                Run go clean

build                Build binary containing service executable

build-cover          Build binary with code coverage detection support

fmt                  Run go fmt -w for all sources

lint                 Run golint

vet                  Run go vet. Report likely mistakes in source code

cyclo                Run gocyclo

ineffassign          Run ineffassign checker

shellcheck           Run shellcheck

errcheck             Run errcheck

goconst              Run goconst checker

gosec                Run gosec checker

abcgo                Run ABC metrics checker

json-check           Check all JSONs for basic syntax

style                Run all the formatting related commands (fmt, vet, lint, cyclo) + check shell scripts

run                  Build the project and executes the binary

test                 Run the unit tests

cover                Generate HTML pages with code coverage

coverage             Display code coverage on terminal

integration_tests    Run all integration tests

rest_api_tests       Run REST API tests

before_commit        Checks done before commit

help                 Show this help screen

function_list        List all functions in generated binary file

```

## Usage

```

Usage:

    ./insights-results-aggregator [command]

The commands are:

                 starts aggregator

    start-service       starts aggregator

    help                prints help

    print-help          prints help

    print-config        prints current configuration set by files & env variables

    print-env           prints env variables

    print-version-info  prints version info

    migration           prints information about migrations (current, latest)

    migration  migrates database to the specified version

```

## BDD tests

Behaviour tests for this service are included in [Insights Behavioral

Spec](https://github.com/RedHatInsights/insights-behavioral-spec) repository.

In order to run these tests, the following steps need to be made:

1. clone the [Insights Behavioral Spec](https://github.com/RedHatInsights/insights-behavioral-spec) repository

1. go into the cloned subdirectory `insights-behavioral-spec`

1. run the `insights_results_aggregator_tests.sh` from this subdirectory

List of all test scenarios prepared for this service is available at

## Package manifest

Package manifest is available at [docs/manifest.txt](docs/manifest.txt).