Работа с New Relic (newrelic dashboard) и Terraform в Unix/Linux

New Relic — это веб-приложение, нацеленное в первую очередь на разработчиков. Его основная цель — отслеживание путей взаимодействия пользователя с разработанными продуктами. Это средство аналитики ПО.

Ключевые особенности New Relic:

  • Мониторинг доступности.
  • Предупреждения и уведомления.
  • Профили производительности.
  • Плагины.
  • Гистограммы и процентили.
  • Доступ API.
  • Время отклика в режиме реального времени.
  • Анализатор производительности виртуальной машины Java.
  • Обнаружение ошибок, анализ.
  • Вызов базы данных с временем отклика и пропускной способностью.
  • Диагностика, трассировка транзакций, трассировка стека.
  • Анализ времени отклика, пропускной способности и разбивка по компонентам.
  • Подробности по производительности SQL.
  • Анализ пользователя в режиме реального времени при просмотре веб-страниц.
  • Кастомные дэшборды.
  • Отслеживание отдельных бизнес-операций.
  • X-Ray сессии для деловых операций.
  • Кросс-трассировка приложений для распределенных приложений.
  • Отчёты по доступности, масштабируемости, развёртыванию.

Установка terraform в Unix/Linux

Установка крайне примитивная и я описал как это можно сделать тут:

Установка terraform в Unix/Linux

Так же, в данной статье, я создал скрипт для автоматической установки данного ПО. Он был протестирован на CentOS 6/7, Debian 8 и на Mac OS X. Все работает должным образом!

Чтобы получить помощь по использованию команд, выполните:

$ terraform --help
Usage: terraform [-version] [-help] <command> [args]

The available commands for execution are listed below.
The most common, useful commands are shown first, followed by
less common or more advanced commands. If you're just getting
started with Terraform, stick with the common commands. For the
other commands, please read the help and docs before usage.

Common commands:
    apply              Builds or changes infrastructure
    console            Interactive console for Terraform interpolations
    destroy            Destroy Terraform-managed infrastructure
    env                Workspace management
    fmt                Rewrites config files to canonical format
    get                Download and install modules for the configuration
    graph              Create a visual graph of Terraform resources
    import             Import existing infrastructure into Terraform
    init               Initialize a Terraform working directory
    output             Read an output from a state file
    plan               Generate and show an execution plan
    providers          Prints a tree of the providers used in the configuration
    push               Upload this Terraform module to Atlas to run
    refresh            Update local state file against real resources
    show               Inspect Terraform state or plan
    taint              Manually mark a resource for recreation
    untaint            Manually unmark a resource as tainted
    validate           Validates the Terraform files
    version            Prints the Terraform version
    workspace          Workspace management

All other commands:
    debug              Debug output management (experimental)
    force-unlock       Manually unlock the terraform state
    state              Advanced state management

Приступим к использованию!

Работа с New Relic (newrelic dashboard) и Terraform в Unix/Linux

У меня есть папка terraform, в ней у меня будут лежать провайдеры с которыми я буду работать. Т.к в этом примере я буду использовать newrelic, то создам данную папку и перейду в нее. Далее, в этой папке, стоит создать:

$ mkdir examples modules

В папке examples, я буду хранить так званые «плейбуки» для разварачивания различных служб, например — zabbix-server, grafana, web-серверы и так далее. В modules директории, я буду хранить все необходимые модули.

Начнем писать модуль, но для этой задачи, я создам папку:

$  mkdir modules/newrelic_dashboard

Переходим в нее:

$ cd modules/newrelic_dashboard

Открываем файл:

$ vim newrelic_dashboard.tf

В данный файл, вставляем:

#---------------------------------------------------
# Add newrelic dashboard
#---------------------------------------------------
resource "newrelic_dashboard" "dashboard" {
    count               = "${var.dashboard && !var.dashboard_custom ? 1 : 0}"
                                 
    title               = "${var.dashboard_title !="" ? "${lower(var.dashboard_title)}" : "${lower(var.name)}-nr-dashboard-${lower(var.environment)}" }"
    icon                = "${var.dashboard_icon}"
    visibility          = "${var.dashboard_visibility}"
    editable            = "${var.dashboard_editable}"

    widget {
        title           = "${var.dashboard_widget_title !="" ? "${lower(var.dashboard_widget_title)}" : "${lower(var.name)}-nr-widget-${lower(var.environment)}" }"
        visualization   = "${var.dashboard_widget_visualization}"
        row             = "${var.dashboard_widget_row}"
        column          = "${var.dashboard_widget_column}"

        width           = "${var.dashboard_widget_width}"
        height          = "${var.dashboard_widget_height}"
        notes           = "${var.dashboard_widget_notes}"
        nrql            = "${var.dashboard_widget_nrql}"
    }
    
    widget {
        title         = "Page Views"
        row           = 1
        column        = 3
        visualization = "billboard"
        nrql          = "SELECT count(*) FROM PageView SINCE 1 week ago"
    }

    lifecycle = {
        create_before_destroy   = true,
        ignore_changes          = []
    }

    depends_on  = []    
}

resource "newrelic_dashboard" "dashboard_custom" {
    count               = "${var.dashboard && var.dashboard_custom ? 1 : 0}"

    title               = "${var.dashboard_title !="" ? "${lower(var.dashboard_title)}" : "${lower(var.name)}-nr-dashboard-${lower(var.environment)}" }"
    icon                = "${var.dashboard_icon}"
    visibility          = "${var.dashboard_visibility}"
    editable            = "${var.dashboard_editable}"

    widget              = "${var.dashboard_custom_widget}"

    lifecycle = {
        create_before_destroy   = true,
        ignore_changes          = []
    }

    depends_on  = []
}

Открываем файл:

$ vim variables.tf

И прописываем:

#-----------------------------------------------------------
# Global 
#-----------------------------------------------------------
variable "name" {
    description = "The name for newrelic_alert resources"
    default     = "test"
}   

variable "environment" {
    description = "environment"
    default     = "prod"
}

#-----------------------------------------------------------
# newrelic dashboard
#-----------------------------------------------------------
variable "dashboard" {
    description = "Enable newrelic_dashboard"
    default     = "false"
}

variable "dashboard_title" {
    description = "(Required) The title of the dashboard."
    default     = ""
}

variable "dashboard_icon" {
    description = "(Optional) The icon for the dashboard. Defaults to bar-chart."
    default     = "bar-chart"
}

variable "dashboard_visibility" {
    description = "(Optional) Who can see the dashboard in an account. Must be owner or all. Defaults to all."
    default     = "all"
}

variable "dashboard_editable" {
    description = "(Optional) Who can edit the dashboard in an account. Must be read_only, editable_by_owner, editable_by_all, or all. Defaults to editable_by_all."
    default     = "editable_by_all"
}

variable "dashboard_widget_title" {
    description = "(Required) A title for the widget."
    default     = ""
}

variable "dashboard_widget_row" {
    description = "(Required) Row position of widget from top left, starting at 1."
    default     = 1
}

variable "dashboard_widget_visualization" {
    description = "(Required) How the widget visualizes data."
    default     = "faceted_line_chart"
}

variable "dashboard_widget_column" {
    description = "(Required) Column position of widget from top left, starting at 1."
    default     = 1
}

variable "dashboard_widget_width" {
    description = "(Optional) Width of the widget. Defaults to 1."
    default     = 1
}

variable "dashboard_widget_height" {
    description = "(Optional) Height of the widget. Defaults to 1."
    default     = 1
}

variable "dashboard_widget_notes" {
    description = "(Optional) Description of the widget."
    default     = ""
}

variable "dashboard_widget_nrql" {
    description = "(Optional) Valid NRQL query string. See Writing NRQL Queries for help."
    default     = ""
}

variable "dashboard_custom" {
    description = "Enable newrelic_dashboard for custom usage"
    default     = "false"
}

variable "dashboard_custom_widget" {
    description = "(Optional) A widget that describes a visualization. See Widgets below for details."
    type        = "list"
    default     = []
}

Собственно в этом файле храняться все переменные. Спасибо кэп!

Открываем последний файл:

$ vim outputs.tf

И в него вставить нужно следующие строки:

#-----------------------------------------------------------
# newrelic_dashboard
#-----------------------------------------------------------
output "newrelic_dashboard_id" {
    description = "ID for newrelic_dashboard"
    value       = "${newrelic_dashboard.dashboard.*.id}"
}

output "newrelic_dashboard_custom_id" {
    description = "ID for dashboard_custom"
    value       = "${newrelic_dashboard.dashboard_custom.*.id}"
}

Переходим теперь в папку aws/examples и создадим еще одну папку для проверки написанного чуда:

$ mkdir newrelic_dashboard && cd $_

Внутри созданной папки открываем файл:

$ vim main.tf

И вставим в него следующий код:

#
# MAINTAINER Vitaliy Natarov "vitaliy.natarov@yahoo.com"
#
terraform {
  required_version = "~> 0.11.11"
}

provider "newrelic" {
    api_key = "75e6741e6326cce1666ecfb94c3c0b8fdf"
}

module "newrelic_dashboard" {
    source                                              = "../../modules/newrelic_dashboard"

    dashboard                                           = "true"
    
    dashboard_custom                                    = "true"
    dashboard_custom_widget                             = [
        {
            title         = "Average Transaction Duration"
            row           = 1
            column        = 1
            width         = 2
            visualization = "faceted_line_chart"
            nrql          = "SELECT AVERAGE(duration) from Transaction FACET appName TIMESERIES auto"
        },
        {
            title         = "Page Views"
            row           = 1
            column        = 3
            visualization = "billboard"
            nrql          = "SELECT count(*) FROM PageView SINCE 1 week ago"
    }
    ]
}

В файле стоит прописать все необходимое, но самое главное:

  • api_key — API ключ, который можно сгенерировать в «‘Account settings’->’API keys'».

Все уже написано и готово к использованию. Ну что, начнем тестирование. В папке с вашим плейбуком, выполняем:

$ terraform init

Этим действием я инициализирую проект. Затем, подтягиваю модуль:

$ terraform get

PS: Для обновление изменений в самом модуле, можно выполнять:

$ terraform get -update

Проверим валидацию:

$ terraform validate

Запускем прогон:

$ terraform plan

Мне вывело что все у меня хорошо и можно запускать деплой:

$ terraform apply

Как видно с вывода, — все прошло гладко! Чтобы удалить созданное творение, можно выполнить:

$ terraform destroy

Еще полезности:

Работа с New Relic (newrelic alert) и Terraform в Unix/Linux

Работа с New Relic (newrelic nrql) и Terraform в Unix/Linux

Работа с New Relic (newrelic infra) и Terraform в Unix/Linux

Работа с New Relic (newrelic synthetics) и Terraform в Unix/Linux

Работа с New Relic (newrelic dashboard) и Terraform в Unix/Linux

Весь материал аплоаджу в github аккаунт для удобства использования:

$ git clone https://github.com/SebastianUA/terraform.git

Вот и все на этом. Данная статья «Работа с New Relic (newrelic dashboard) и Terraform в Unix/Linux» завершена.

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

Этот сайт использует Akismet для борьбы со спамом. Узнайте как обрабатываются ваши данные комментариев.