Module erlcloud_cloudwatch_logs

Data Types

access_key_id()

access_key_id() = string()

cw_host()

cw_host() = string()

error_result()

error_result() = {error, Reason::term()}

events()

events() = [#{message => binary(), timestamp => pos_integer()}]

filter_name_prefix()

filter_name_prefix() = string() | binary() | undefined

limit()

limit() = pos_integer() | undefined

log_group()

log_group() = jsx:json_term()

log_group_name()

log_group_name() = string() | binary() | undefined

log_group_name_prefix()

log_group_name_prefix() = string() | binary() | undefined

log_stream()

log_stream() = jsx:json_term()

log_stream_name()

log_stream_name() = string() | binary() | undefined

log_stream_order()

log_stream_order() = log_stream_name | last_event_time | undefined

log_stream_prefix()

log_stream_prefix() = string() | binary() | undefined

metric_filters()

metric_filters() = jsx:json_term()

metric_name()

metric_name() = string() | binary() | undefined

metric_namespace()

metric_namespace() = string() | binary() | undefined

paging_token()

paging_token() = string() | binary() | undefined

result_paged()

result_paged(ObjectType) = success_result_paged(ObjectType) | error_result()

secret_access_key()

secret_access_key() = string()

seq_token()

seq_token() = string() | binary() | undefined

success_result_paged()

success_result_paged(ObjectType) = {ok, [ObjectType], paging_token()}

tag()

tag() = {binary(), binary()}

tags_return()

tags_return() = jsx:json_term()

Function Index

configure/2
configure/3
describe_log_groups/0 DescribeLogGroups action http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html.
describe_log_groups/1
describe_log_groups/2
describe_log_groups/3
describe_log_groups/4
describe_log_streams/1 DescribeLogStreams action https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogStreams.html.
describe_log_streams/2
describe_log_streams/3
describe_log_streams/5
describe_log_streams/6
describe_log_streams/7
describe_metric_filters/0 DescribeMetricFilters action https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeMetricFilters.html.
describe_metric_filters/1
describe_metric_filters/2
describe_metric_filters/3
describe_metric_filters/4
describe_metric_filters/6
describe_metric_filters/7
list_tags_log_group/1 ListTagsLogGroup https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html.
list_tags_log_group/2
new/2
new/3
put_logs_events/4.
put_logs_events/5
tag_log_group/2 TagLogGroup action https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagLogGroup.html.
tag_log_group/3

Function Details

configure/2

configure(AccessKeyID::access_key_id(), SecretAccessKey::secret_access_key()) -> ok

configure/3

configure(AccessKeyID::access_key_id(), SecretAccessKey::secret_access_key(), Host::cw_host()) -> ok

describe_log_groups/0

describe_log_groups() -> result_paged(log_group())

DescribeLogGroups action http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html

describe_log_groups/1

describe_log_groups(Aws_config::aws_config() | log_group_name_prefix()) -> result_paged(log_group())

describe_log_groups/2

describe_log_groups(LogGroupNamePrefix::log_group_name_prefix(), Config::aws_config()) -> result_paged(log_group())

describe_log_groups/3

describe_log_groups(LogGroupNamePrefix::log_group_name_prefix(), Limit::limit(), Config::aws_config()) -> result_paged(log_group())

describe_log_groups/4

describe_log_groups(LogGroupNamePrefix::log_group_name_prefix(), Limit::limit(), Token::paging_token(), Config::aws_config()) -> result_paged(log_group())

describe_log_streams/1

describe_log_streams(LogGroupName::log_group_name()) -> result_paged(log_stream())

DescribeLogStreams action https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogStreams.html

describe_log_streams/2

describe_log_streams(LogGroupName::log_group_name(), Config::aws_config()) -> result_paged(log_stream())

describe_log_streams/3

describe_log_streams(LogGroupName::log_group_name(), LogStreamPrefix::log_stream_prefix(), Config::aws_config()) -> result_paged(log_stream())

describe_log_streams/5

describe_log_streams(LogGroupName::log_group_name(), LogStreamPrefix::log_stream_prefix(), OrderBy::log_stream_order(), Desc::boolean(), Config::aws_config()) -> result_paged(log_stream())

describe_log_streams/6

describe_log_streams(LogGroupName::log_group_name(), LogStreamPrefix::log_stream_prefix(), OrderBy::log_stream_order(), Desc::boolean(), Limit::limit(), Config::aws_config()) -> result_paged(log_stream())

describe_log_streams/7

describe_log_streams(LogGroupName::log_group_name(), LogStreamPrefix::log_stream_prefix(), OrderBy::log_stream_order(), Desc::boolean(), Limit::limit(), Token::paging_token(), Config::aws_config()) -> result_paged(log_stream())

describe_metric_filters/0

describe_metric_filters() -> result_paged(metric_filters())

DescribeMetricFilters action https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeMetricFilters.html

describe_metric_filters/1

describe_metric_filters(Aws_config::aws_config() | log_group_name()) -> result_paged(metric_filters())

describe_metric_filters/2

describe_metric_filters(LogGroupName::log_group_name(), Config::aws_config()) -> result_paged(metric_filters())

describe_metric_filters/3

describe_metric_filters(LogGroupName::log_group_name(), Limit::limit(), Config::aws_config()) -> result_paged(metric_filters())

describe_metric_filters/4

describe_metric_filters(LogGroupName::log_group_name(), Limit::limit(), FilterNamePrefix::filter_name_prefix(), Config::aws_config()) -> result_paged(metric_filters())

describe_metric_filters/6

describe_metric_filters(LogGroupName::log_group_name(), Limit::limit(), FilterNamePrefix::filter_name_prefix(), MetricName::metric_name(), MetricNamespace::metric_namespace(), Config::aws_config()) -> result_paged(metric_filters())

describe_metric_filters/7

describe_metric_filters(LogGroupName::log_group_name(), Limit::limit(), FilterNamePrefix::filter_name_prefix(), MetricName::metric_name(), MetricNamespace::metric_namespace(), PrevToken::paging_token(), Config::aws_config()) -> result_paged(metric_filters())

list_tags_log_group/1

list_tags_log_group(LogGroup::log_group_name()) -> tags_return()

ListTagsLogGroup https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html

list_tags_log_group/2

list_tags_log_group(LogGroup::log_group_name(), Config::aws_config()) -> tags_return()

new/2

new(AccessKeyID::access_key_id(), SecretAccessKey::secret_access_key()) -> aws_config()

new/3

new(AccessKeyID::access_key_id(), SecretAccessKey::secret_access_key(), Host::cw_host()) -> aws_config()

put_logs_events/4

put_logs_events(LogGroup::log_group_name(), LogStream::log_stream_name(), SeqToken::seq_token(), Events::events()) -> datum:either(seq_token())

PutLogEvents action https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html

Example

Put log events requires a Upload Sequence Token, it is available via DescribeLogStreams

    application:ensure_all_started(erlcloud).
    {ok, Config} = erlcloud_aws:auto_config().
    {ok, Streams, _} = erlcloud_cloudwatch_logs:describe_log_streams(GroupName, StreamName, Config).
    {_, Seq} = lists:keyfind(<<"uploadSequenceToken">>, 1, hd(Streams)).
 
    Batch = [#{timestamp => 1526233086694, message => <<"Example Message">>}].
    erlcloud_cloudwatch_logs:put_logs_events(GroupName, StreamName, Seq, Batch, Config).

put_logs_events/5

put_logs_events(LogGroup::log_group_name(), LogStream::log_stream_name(), SeqToken::seq_token(), Events::events(), Config::aws_config()) -> datum:either(seq_token())

tag_log_group/2

tag_log_group(LogGroup::log_group_name(), Tags::[tag()]) -> ok

TagLogGroup action https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagLogGroup.html

tag_log_group/3

tag_log_group(LogGroup::log_group_name(), Tags::[tag()], Config::aws_config()) -> ok


Generated by EDoc