prom_collector_registry.h

Go to the documentation of this file.

/*
Copyright 2019-2020 DigitalOcean Inc.
Copyright 2021 Jens Elkner <jel+libprom@cs.uni-magdeburg.de>
 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
     http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
 
#ifndef PROM_REGISTRY_H
#define PROM_REGISTRY_H
 
#include <stdbool.h>
#include "prom_collector.h"
#include "prom_metric.h"
 
#define METRIC_LABEL_SCRAPE "libprom"
 
#define METRIC_NAME_SCRAPE "scrape_duration_seconds"
 
#define COLLECTOR_NAME_DEFAULT "default"
 
#define COLLECTOR_NAME_PROCESS "process"
 
#define REGISTRY_NAME_DEFAULT "default"
 
enum prom_init_flag {
    PROM_NONE = 0,
    PROM_PROCESS = 1,
    PROM_SCRAPETIME = 2,
    PROM_SCRAPETIME_ALL = 4,
    PROM_COMPACT = 8
};
 
typedef unsigned int PROM_INIT_FLAGS;
 
typedef struct pcr pcr_t;
 
extern pcr_t *PROM_COLLECTOR_REGISTRY;
#define PROM_COLLECTOR_REGISTRY_DEFAULT PROM_COLLECTOR_REGISTRY
 
int pcr_default_init(void);
 
int pcr_init(PROM_INIT_FLAGS features, const char *mprefix);
 
pcr_t *pcr_new(const char *name);
 
int pcr_destroy(pcr_t *self);
 
int pcr_enable_process_metrics(pcr_t *self);
 
int pcr_enable_scrape_metrics(pcr_t *self);
 
prom_metric_t *pcr_must_register_metric(prom_metric_t *metric);
 
int pcr_register_metric(prom_metric_t *metric);
 
int pcr_register_collector(pcr_t *self, prom_collector_t *collector);
 
prom_collector_t *pcr_get(pcr_t *self, const char *name);
 
char *pcr_bridge(pcr_t *self);
 
int pcr_validate_metric_name(pcr_t *self, const char *metric_name);
 
int pcr_check_name(const char *name, bool is_label);
 
#endif  // PROM_H