org.neo4j.udc.UsageDataKeys Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ongdb-kernel Show documentation
ONgDB kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see https://graphfoundation.org.
There is a newer version: 3.6.2
Show newest version
/*
 * Copyright (c) 2018-2020 "Graph Foundation,"
 * Graph Foundation, Inc. [https://graphfoundation.org]
 *
 * This file is part of ONgDB.
 *
 * ONgDB is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
/*
 * Copyright (c) 2002-2020 "Neo4j,"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.udc;

import org.neo4j.concurrent.DecayingFlags;
import org.neo4j.concurrent.DecayingFlags.Key;
import org.neo4j.concurrent.RecentK;
import org.neo4j.kernel.impl.factory.Edition;
import org.neo4j.kernel.impl.factory.OperationalMode;

import static org.neo4j.udc.UsageDataKey.key;

/**
 * Inventory of common keys. This list is not exhaustive, and all items listed may not be available.
 * 
 * Still, this serves as a useful starting point for what you can expect to find, and new items added are encouraged to have their keys listed here.
 */
public class UsageDataKeys
{
    /**
     * Edition of ONgDB running, eg 'community' or 'enterprise'
     */
    public static final UsageDataKey edition = key( "ongdb.edition", Edition.unknown );

    /**
     * Version of ONgDB running, eg. 1.2.3-RC1
     */
    public static final UsageDataKey version = key( "ongdb.version", "N/A" );

    /**
     * Revision of ONgDB running, a link back to source control revision ids.
     */
    public static final UsageDataKey revision = key( "ongdb.revision", "N/A" );

    /**
     * Operational mode of the database
     */
    public static final UsageDataKey operationalMode = key( "ongdb.opMode", OperationalMode.unknown );

    /**
     * Self-reported names of clients connecting to us.
     */
    public static final UsageDataKey> clientNames = key( "ongdb.clientNames", () -> new RecentK<>( 10 ) );

    /**
     * Cluster server ID
     */
    public static final UsageDataKey serverId = key( "ongdb.serverId" );

    public interface Features
    {
        // Note: The indexes used here is how we track which feature a flag refers to.
        //       Be very careful about re-using indexes so features don't get confused.
        Key http_cypher_endpoint = new Key( 0 );
        Key http_tx_endpoint = new Key( 1 );
        Key http_batch_endpoint = new Key( 2 );

        Key bolt = new Key( 3 );
    }

    private UsageDataKeys()
    {
    }

    /**
     * Tracks features in use, including decay such that features that are not used for a while are marked as no longer in use.
     * 
     * Decay is handled by an external mechanism invoking a 'sweep' method on this DecayingFlags instance. See usages of this field to find where that happens.
     */
    public static final UsageDataKey features = key( "ongdb.features", () -> new DecayingFlags( 7/*days*/ ) );
}