public function NewRelicRpmSettings::buildForm in New Relic 8

Same name and namespace in other branches

1. 2.x src/Form/NewRelicRpmSettings.php \Drupal\new_relic_rpm\Form\NewRelicRpmSettings::buildForm()
2. 2.0.x src/Form/NewRelicRpmSettings.php \Drupal\new_relic_rpm\Form\NewRelicRpmSettings::buildForm()

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/NewRelicRpmSettings.php, line 31

Class

NewRelicRpmSettings

Provides a settings form to configure the New Relic RPM module.

Namespace

Drupal\new_relic_rpm\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $form = [];
  $form['api_key'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('API Key'),
    '#description' => $this
      ->t('Enter your New Relic API key if you wish to view reports and analysis within Drupal.'),
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('api_key'),
  ];
  $form['transactions'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Transactions'),
    '#open' => TRUE,
  ];
  $form['transactions']['track_drush'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Drush transactions'),
    '#description' => $this
      ->t('How do you wish New Relic to track drush commands?'),
    '#options' => [
      'ignore' => $this
        ->t('Ignore completely'),
      'bg' => $this
        ->t('Track as background tasks'),
      'norm' => $this
        ->t('Track normally'),
    ],
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('track_drush'),
  ];
  $form['transactions']['track_cron'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Cron transactions'),
    '#description' => $this
      ->t('How do you wish New Relic to track cron tasks?'),
    '#options' => [
      'ignore' => $this
        ->t('Ignore completely'),
      'bg' => $this
        ->t('Track as background tasks'),
      'norm' => $this
        ->t('Track normally'),
    ],
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('track_cron'),
  ];
  $roles = user_role_names();
  $form['transactions']['ignore_roles'] = [
    '#type' => 'select',
    '#multiple' => TRUE,
    '#title' => $this
      ->t('Ignore roles'),
    '#description' => $this
      ->t('Select roles that you wish to be ignored on the New Relic dashboards. Any user with at least one of the selected roles will be ignored.'),
    '#options' => $roles,
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('ignore_roles'),
  ];
  $form['transactions']['ignore_urls'] = [
    '#type' => 'textarea',
    '#wysiwyg' => FALSE,
    '#title' => $this
      ->t('Ignore URLs'),
    '#description' => $this
      ->t('Enter URLs you wish New Relic to ignore. Enter one URL per line.'),
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('ignore_urls'),
  ];
  $form['transactions']['bg_urls'] = [
    '#type' => 'textarea',
    '#wysiwyg' => FALSE,
    '#title' => $this
      ->t('Background URLs'),
    '#description' => $this
      ->t('Enter URLs you wish to have tracked as background tasks. Enter one URL per line.'),
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('bg_urls'),
  ];
  $form['transactions']['exclusive_urls'] = [
    '#type' => 'textarea',
    '#wysiwyg' => FALSE,
    '#title' => $this
      ->t('Exclusive URLs'),
    '#description' => $this
      ->t('Enter URLs you wish to exclusively track. This is useful for debugging specific issues. **NOTE** Entering URLs here effectively marks all other URLs as ignored. Leave blank to disable.'),
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('exclusive_urls'),
  ];
  $form['error'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Error analytics'),
    '#open' => TRUE,
  ];
  $form['error']['watchdog_severities'] = [
    '#type' => 'select',
    '#multiple' => TRUE,
    '#title' => $this
      ->t('Forward watchdog messages'),
    '#description' => $this
      ->t('Select which watchdog severities should be forwarded to New Relic API as errors.'),
    '#options' => RfcLogLevel::getLevels(),
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('watchdog_severities'),
  ];
  $form['error']['override_exception_handler'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Override exception handler'),
    '#description' => $this
      ->t('Check to override default Drupal exception handler and to have exceptions passed to New Relic.'),
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('override_exception_handler'),
  ];
  $form['deployment'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Deployments'),
    '#open' => TRUE,
  ];
  $form['deployment']['module_deployment'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Track module activation as deployment'),
    '#description' => $this
      ->t('Turning this on will create a "deployment" on the New Relic dashboard each time a module is installed or uninstalled. This will help you track before and after statistics.'),
    '#options' => [
      1 => $this
        ->t('Enable'),
      0 => $this
        ->t('Disable'),
    ],
    '#default_value' => (int) $this
      ->config('new_relic_rpm.settings')
      ->get('module_deployment'),
  ];
  $form['deployment']['config_import'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Track configuration imports as deployment'),
    '#description' => $this
      ->t('Turning this on will create a "deployment" on the New Relic dashboard each time a set of configuration is imported. This will help you track before and after statistics.'),
    '#options' => [
      1 => $this
        ->t('Enable'),
      0 => $this
        ->t('Disable'),
    ],
    '#default_value' => (int) $this
      ->config('new_relic_rpm.settings')
      ->get('config_import'),
  ];
  $form['browser'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Browser'),
    '#open' => TRUE,
  ];
  $form['browser']['disable_autorum'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Disable AutoRUM'),
    '#description' => $this
      ->t('Check to disable the automatic real user monitoring inserted by a New Relic transaction.'),
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('disable_autorum'),
  ];
  $form['insights'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Insights'),
    '#open' => TRUE,
  ];
  $form['insights']['views_log_slow'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Track slow views'),
    '#description' => $this
      ->t('Check if you want to log slow views in New Relic as custom events.'),
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('views_log_slow'),
  ];
  $form['insights']['views_log_threshold'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Slow view threshold'),
    '#field_suffix' => 'ms',
    '#description' => $this
      ->t('The amount of time in milliseconds before a slow view event is logged in New Relic.'),
    '#default_value' => $this
      ->config('new_relic_rpm.settings')
      ->get('views_log_threshold'),
  ];
  return parent::buildForm($form, $form_state);
}