migrating-syslog-configuration.html.md.erb

---
title: Migrating existing Syslog configuration to Tanzu Operations Manager
owner: Ops Manager
---

You can migrate existing syslog properties that are defined by a tile into a syslog form that
is provided in Tanzu Operations Manager v2.9 and later.

When you enable the Tanzu Operations Manager syslog feature, Tanzu Operations Manager:

* Provides your tile with its own syslog form.
* Ensures that the syslog BOSH release is automatically injected into the instance groups of your product.
* Includes syslog configuration properties when Tanzu Operations Manager injects the syslog release into your product.

## <a id="syslog-data-model"></a>Syslog data model

 The following table lists the Tanzu Operations Manager syslog parameters that you can use to migrate your existing
 configurations:

 <table class=“table”>
 <thead>
  <tr>
    <th width="175">Syslog parameter</th>
    <th>Data Type</th>
    <th width="150">Required</th>
    <th>Notes</th>
  </tr>
  </thead>
  <tr>
    <td><code>enabled</code></td>
    <td>boolean</td>
    <td>No</td>
    <td> Defaults to <code>false</code></td>
  </tr>
  <tr>
    <td><code>address</code></td>
    <td>string</td>
    <td>Yes</td>
    <td>The address or host for the syslog server. <br>Must be a valid network address</td>
  </tr>
  <tr>
    <td><code>port</code></td>
    <td>integer</td>
    <td>Yes</td>
    <td>The port on which the syslog server listens</td>
  </tr>
  <tr>
    <td><code>transport_protocol</code></td>
    <td>string</td>
    <td>No</td>
    <td>The transport protocol used to send syslog entriess to the server.
      <br>Valid values are <code>tcp</code> and <code>udp</code>. Defaults to <code>tcp</code></td>
  </tr>
  <tr>
    <td><code>tls_enabled</code></td>
    <td>boolean</td>
    <td>No</td>
    <td>Send logs encrypted to syslog server through TLS. Defaults to <code>false</code></td>
  </tr>
  <tr>
    <td><code>permitted_peer</code></td>
    <td>boolean</td>
    <td>No, unless <code>tls_enabled</code> is <code>true</code></td>
    <td> Defaults to <code>false</code>.</td>
  </tr>
  <tr>
    <td><code>ssl_ca_certificate</code></td>
    <td>string</td>
    <td>No, unless <code>tls_enabled</code> is <code>true</code></td>
    <td>Must be a valid certificate<br>
      Defaults to <code>null</code>.</td>
  </tr>
  <tr>
    <td><code>queue_size</code></td>
    <td>integer</td>
    <td>No</td>
    <td>The number of log entries the buffer holds before dropping messages. A larger buffer size
      might overload the system. Defaults to <code>100000</code></td>
  </tr>
  <tr>
    <td><code>forward_debug_logs</code></td>
    <td>boolean</td>
    <td>No</td>
    <td>Defaults to <code>false</code></td>
  </tr>
  <tr>
    <td><code>custom_rsyslog_configuration</code></td>
    <td>text</td>
    <td>No</td>
    <td>Additional configuration for rsyslog written in the rainerscript syntax.
        For example, <code> ($app-name startswith "exampleComponent") and stop</code>
        This code drops all traffic from a particular component.
        The entered configuration is applied before the forwarding rule.</td>
  </tr>
</table>

## <a id="javascript"></a> Use the JavaScript migration process

Tile authors can write a JavaScript migration to move their existing syslog properties into the
syslog form provided by Tanzu Operations Manager. After a successful migration, Tanzu Operations Manager presents the
migrated syslog properties in the Syslog form of the tile.

1. Set the `opsmanager_syslog` property to `true` in your `metadata.yml` file.
For more information, see [opsmanager_syslog](./property-template-references.html#syslog-flag).

1. To write your JavaScript migration, use the following example as a template:


    ```js
    exports.migrate = function(input) {
      input.syslog_configuration = {
        enabled: true,
        address: input.properties['.PROPERTY-REFERENCE.EXAMPLE-ADDRESS'],
        port: input.properties['.PROPERTY-REFERENCE.EXAMPLE-PORT'],
        transport_protocol: input.properties['.PROPERTY-REFERENCE.EXAMPLE-PROTOCOL']
      };
      return input;
    };
    ```

    Replace the example text as follows:

    * `PROPERTY-REFERENCE`: Replace with the property reference that corresponds to the metadata
    file, such as `properties`.
    For more information about migrating properties, see [Tile Upgrades](./tile-upgrades.html#import).
    * `EXAMPLE-ADDRESS`: Replace with the property name of the address.
    * `EXAMPLE-PORT`: Replace with the property name of the port.
    * `EXAMPLE-PROTOCOL`: Replace with the property name of the transport protocol.

1. Save the JavaScript file to the `PRODUCT/migrations/v1` directory of your `.pivotal` file.
1. Remove the following:

    * From your product template, `form_types` which allow operators to configure tile specific syslog configuration
    * From your tile, the syslog BOSH release.
    * From your deployment manifest, syslog configuration properties.

1. To ensure that operators do not try to update syslog configuration properties with no outward
capability, mark all existing syslog configuration properties in your product as non-configurable.

1. Update the description for the deprecated properties to state that they are deprecated and are no
longer used to configure the syslog.

1. Run a deployment test of your tile using the procedures in [Testing Tiles](./testing.html).

1. Verify that your syslog properties are migrated into the Tanzu Operations Manager syslog
configuration:

    * View the configurations in the **Syslog** pane in Tanzu Operations Manager **Settings** page.
    * View your syslog properties using the `syslog_configuration` Tanzu Operations Manager API endpoint.

    For more information about the `syslog_configuration` API endpoint, see
    [Retrieving syslog configuration for a product](https://docs.pivotal.io/platform/2-10/opsman-api/#tag/Syslog-Configuration/paths/~1api~1v0~1staged~1products~1{product_guid}~1syslog_configuration/get).

<p class="note">
<span class="note__title">Note</span>
In the next version of your product, remove the deprecated syslog configuration properties.
</p>