org.graylog2.telemetry.rest.TelemetryResponseFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.telemetry.rest;

import org.graylog2.system.stats.elasticsearch.NodeInfo;
import org.graylog2.telemetry.enterprise.TelemetryLicenseStatus;
import org.joda.time.DateTime;

import java.util.Collection;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

import static org.graylog2.shared.utilities.StringUtils.f;
import static org.graylog2.telemetry.cluster.db.DBTelemetryClusterInfo.FIELD_IS_LEADER;
import static org.graylog2.telemetry.cluster.db.DBTelemetryClusterInfo.FIELD_VERSION;

class TelemetryResponseFactory {
    private static final String CURRENT_USER = "current_user";
    private static final String PREFIX_USER = "user";
    private static final String USER_TELEMETRY_SETTINGS = "user_telemetry_settings";
    private static final String CLUSTER = "cluster";
    private static final String LICENSE = "license";
    private static final String PLUGIN = "plugin";
    private static final String SEARCH_CLUSTER = "search_cluster";
    private static final String DATA_NODES = "data_nodes";

    private static boolean isLeader(Map n) {
        if (n.get(FIELD_IS_LEADER) instanceof Boolean isLeader) {
            return isLeader;
        }
        return false;
    }

    Map createTelemetryResponse(Map clusterInfo,
                                                Map userInfo,
                                                Map pluginInfo,
                                                Map searchClusterInfo,
                                                List licenseStatuses,
                                                TelemetryUserSettings telemetryUserSettings,
                                                Map dataNodeInfo) {
        Map telemetryResponse = new LinkedHashMap<>();
        telemetryResponse.put(CURRENT_USER, userInfo);
        telemetryResponse.put(USER_TELEMETRY_SETTINGS, telemetryUserSettings);
        telemetryResponse.put(CLUSTER, clusterInfo);
        telemetryResponse.put(LICENSE, createLicenseInfo(licenseStatuses));
        telemetryResponse.put(PLUGIN, pluginInfo);
        telemetryResponse.put(SEARCH_CLUSTER, searchClusterInfo);
        telemetryResponse.put(DATA_NODES, dataNodeInfo);
        return telemetryResponse;
    }

    Map createTelemetryDisabledResponse(TelemetryUserSettings telemetryUserSettings) {
        return Map.of(USER_TELEMETRY_SETTINGS, telemetryUserSettings);
    }

    Map createUserInfo(String userHash,
                                       boolean isLocalAdmin,
                                       int rolesCount,
                                       int teamsCount) {
        Map userInfo = new LinkedHashMap<>();
        userInfo.put("user", userHash);
        userInfo.put(f("%s_is_local_admin", PREFIX_USER), isLocalAdmin);
        userInfo.put(f("%s_role_count", PREFIX_USER), rolesCount);
        userInfo.put(f("%s_team_count", PREFIX_USER), teamsCount);
        return userInfo;
    }

    Map createClusterInfo(String clusterId,
                                          DateTime clusterCreationDate,
                                          Map> nodes,
                                          long averageLastMonthTraffic,
                                          long usersCount,
                                          int licenseCount,
                                          String installationSource
    ) {
        Map clusterInfo = new LinkedHashMap<>();
        clusterInfo.put("cluster_id", clusterId);
        clusterInfo.put("cluster_creation_date", clusterCreationDate);
        clusterInfo.put("nodes_count", nodes.size());
        clusterInfo.put("traffic_last_month", averageLastMonthTraffic);
        clusterInfo.put("users_count", usersCount);
        clusterInfo.put("license_count", licenseCount);
        clusterInfo.put("node_leader_app_version", leaderNodeVersion(nodes));
        clusterInfo.put("installation_source", installationSource);
        clusterInfo.put("nodes", nodes);
        return clusterInfo;

    }

    private Object leaderNodeVersion(Map> nodes) {
        return nodes.values().stream()
                .filter(TelemetryResponseFactory::isLeader)
                .map(stringObjectMap -> stringObjectMap.get(FIELD_VERSION))
                .findFirst()
                .orElse("unknown");
    }

    Map createPluginInfo(boolean isEnterprisePluginInstalled,
                                         List plugins) {
        Map userInfo = new LinkedHashMap<>();
        userInfo.put(f("%s_is_enterprise_plugin_installed", PLUGIN), isEnterprisePluginInstalled);
        userInfo.put("plugins", plugins);
        return userInfo;
    }

    Map createSearchClusterInfo(int nodesCount,
                                                String version,
                                                Map nodes) {
        Map userInfo = new LinkedHashMap<>();
        userInfo.put(f("%s_nodes_count", SEARCH_CLUSTER), nodesCount);
        userInfo.put(f("%s_version", SEARCH_CLUSTER), version);
        userInfo.put("nodes", nodes);
        return userInfo;
    }

    private Map createLicenseInfo(List telemetryLicenseStatuses) {
        Map> groupedBySubject = telemetryLicenseStatuses.stream()
                .collect(Collectors.groupingBy(TelemetryLicenseStatus::subject));

        List uniqueLicenses = groupedBySubject.values().stream()
                .map(this::filter).flatMap(Collection::stream).toList();
        Map licenses = new LinkedHashMap<>();
        for (TelemetryLicenseStatus l : uniqueLicenses) {
            String licenseString = formatLicenseString(l);
            licenses.put(f("%s_expired", licenseString), l.expired());
            licenses.put(f("%s_valid", licenseString), l.valid());
            licenses.put(f("%s_violated", licenseString), l.violated());
            licenses.put(f("%s_expiration_date", licenseString), l.expirationDate());
            licenses.put(f("%s_traffic_limit", licenseString), l.trafficLimit());
        }
        return licenses;
    }

    private List filter(List telemetryLicenseStatuses1) {
        Comparator compareIsValid = Comparator.comparing(TelemetryLicenseStatus::valid).reversed();
        Comparator compareIsExpired = Comparator.comparing(TelemetryLicenseStatus::expired);
        Comparator compareByDate = Comparator.comparing(TelemetryLicenseStatus::expirationDate).reversed();

        return telemetryLicenseStatuses1.stream()
                .min(compareIsValid.thenComparing(compareIsExpired).thenComparing(compareByDate))
                .map(List::of)
                .orElse(List.of());
    }

    private String formatLicenseString(TelemetryLicenseStatus telemetryLicenseStatus) {
        return telemetryLicenseStatus.subject().replace("/", "_").substring(1);
    }
}