# Module autoscale_server

- Description
- Data Types
- Function Index
- Function Details

Server for collecting autoscale plot data from autoscale leader(s).

Copyright © 2013-2015 Zuse Institute Berlin

Version: $Id$

Behaviours: `gen_component`.

Authors: Ufuk Celebi (`celebi@zib.de`).

## Description

Server for collecting autoscale plot data from autoscale leader(s).

{autoscale_server, true} in the config will enable this service. The autoscale processes from which data is collected assume that this server runs in the same VM as mgmt_server (needs to be set in config).

{autoscale_server_plot_path, PATH} needs to be set in order to write the collected data to the file system (see on({write_to_file})).

## Data Types

### message()

    message() =
        {collect,
         PlotKey :: atom(),
         Timestamp :: pos_integer(),
         Value :: number()} |
        {reset} |
        {write_to_file}

### state()

    state() =
        {PlotData ::
             dict:dict(PlotKey :: atom(),
                       {Timestamp :: pos_integer(), Value :: number()})} |
        unknown_event

## Function Index

check_config/0 | Checks whether config parameters for autoscale_server exist and are valid.
init/1 |
log/1 |
log/2 |
on/2 |
start_gen_component/5 |
start_link/1 |

## Function Details

### start_gen_component/5

    start_gen_component(Module :: module(),
                        Handler :: gen_component:handler(),
                        Args :: term(),
                        Options :: [gen_component:option()],
                        Self :: pid()) ->
                           no_return() | ok

### start_link/1

    start_link(ServiceGroup :: pid_groups:groupname()) -> {ok, pid()}

### init/1

    init(Options :: null) -> state()

### on/2

    on(X1 :: message(), X2 :: state()) -> state()

### log/2

    log(Key :: atom(), Value :: term()) -> ok

### log/1

    log(KeyValueList :: [{Key :: atom(), Value :: term()}]) -> ok

### check_config/0

    check_config() -> boolean()

Checks whether config parameters for autoscale_server exist and are valid.

Generated by EDoc, Feb 29 2016, 16:12:22.