commands

^

Invoke-DbaPfRelog

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows only

 

Synopsis

Pipeline-compatible wrapper for the relog command which is available on modern Windows platforms.

Description

Pipeline-compatible wrapper for the relog command. Relog is useful for converting Windows Perfmon.

Extracts performance counters from performance counter logs into other formats, such as text-TSV (for tab-delimited text), text-CSV (for comma-delimited text), binary-BIN, or SQL.

relog "C:\PerfLogs\Admin\System Correlation\WORKSTATIONX_20180112-000001\DataCollector01.blg" -o C:\temp\foo.csv -f tsv

If you find any input hangs, please send us the output so we can accommodate for it then use -Raw for an immediate solution.

Syntax

Invoke-DbaPfRelog
    [[-Path] <String[]>]
    [[-Destination] <String>]
    [[-Type] <String>]
    [-Append]
    [-AllowClobber]
    [[-PerformanceCounter] <String[]>]
    [[-PerformanceCounterPath] <String>]
    [[-Interval] <Int32>]
    [[-BeginTime] <DateTime>]
    [[-EndTime] <DateTime>]
    [[-ConfigPath] <String>]
    [-Summary]
    [[-InputObject] <Object[]>]
    [-Multithread]
    [-AllTime]
    [-Raw]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Invoke-DbaPfRelog -Path C:\temp\perfmon.blg

Creates C:\temp\perfmon.tsv from C:\temp\perfmon.blg.

Example: 2
PS C:\> Invoke-DbaPfRelog -Path C:\temp\perfmon.blg -Destination C:\temp\a\b\c

Creates the temp, a, and b directories if needed, then generates c.tsv (tab separated) from C:\temp\perfmon.blg.
Returns the newly created file as a file object.

Example: 3
PS C:\> Get-DbaPfDataCollectorSet -ComputerName sql2016 | Get-DbaPfDataCollector | Invoke-DbaPfRelog -Destination C:\temp\perf

Creates C:\temp\perf if needed, then generates computername-datacollectorname.tsv (tab separated) from the latest logs of all data collector sets on sql2016. This destination format was chosen to
avoid naming conflicts with piped input.

Example: 4
PS C:\> Invoke-DbaPfRelog -Path C:\temp\perfmon.blg -Destination C:\temp\a\b\c -Raw
[Invoke-DbaPfRelog][21:21:35] relog "C:\temp\perfmon.blg" -f csv -o C:\temp\a\b\c<br>
Input<br>

#####
File(s):<br>
C:\temp\perfmon.blg (Binary)<br>
Begin:    1/13/2018 5:13:23<br>
End:      1/13/2018 14:29:55<br>
Samples:  2227<br>
100.00%<br>
Output<br>

#####
File:     C:\temp\a\b\c.csv<br>
Begin:    1/13/2018 5:13:23<br>
End:      1/13/2018 14:29:55<br>
Samples:  2227<br>
The command completed successfully.<br>
```<br>
Creates the temp, a, and b directories if needed, then generates c.tsv (tab separated) from C:\temp\perfmon.blg then outputs the raw results of the relog command.<br>

##### Example:  5 

PS C:> Invoke-DbaPfRelog -Path 'C:\temp\perflog with spaces.blg' -Destination C:\temp\a\b\c -Type csv -BeginTime ((Get-Date).AddDays(-30)) -EndTime ((Get-Date).AddDays(-1))

Creates the temp, a, and b directories if needed, then generates c.csv (comma separated) from C:\temp\perflog with spaces.blg', starts 30 days ago and ends one day ago.<br>

##### Example:  6 

PS C:> $servers | Get-DbaPfDataCollectorSet | Get-DbaPfDataCollector | Invoke-DbaPfRelog -Multithread -AllowClobber

Relogs latest data files from all collectors within the servers listed in $servers.<br>

##### Example:  7 

PS C:> Get-DbaPfDataCollector -Collector DataCollector01 | Invoke-DbaPfRelog -AllowClobber -AllTime

Relogs all the log files from the DataCollector01 on the local computer and allows overwrite.<br>
### Optional Parameters
##### -Path
Specifies the pathname of an existing performance counter log or performance counter path. You can specify multiple input files.<br>

|  |  |
| - | - |
| Alias | FullName |
| Required | False |
| Pipeline | true (ByPropertyName) |
| Default Value |  |

##### -Destination
Specifies the pathname of the output file or SQL database where the counters will be written. Defaults to the same directory as the source.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -Type
The output format. Defaults to tsv. Options include tsv, csv, bin, and sql.
For a SQL database, the output file specifies the DSN!counter_log. You can specify the database location by using the ODBC manager to configure the DSN (Database System Name).
For more information, read here: https://technet.microsoft.com/en-us/library/bb490958.aspx<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | tsv |
| Accepted Values | tsv,csv,bin,sql |

##### -Append
If this switch is enabled, output will be appended to the specified file instead of overwriting. This option does not apply to SQL format where the default is always to append.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | False |

##### -AllowClobber
If this switch is enabled, the destination file will be overwritten if it exists.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | False |

##### -PerformanceCounter
Specifies the performance counter path to log.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -PerformanceCounterPath
Specifies the pathname of the text file that lists the performance counters to be included in a relog file. Use this option to list counter paths in an input file, one per line. Default setting is 
all counters in the original log file are relogged.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -Interval
Specifies sample intervals in "n" records. Includes every nth data point in the relog file. Default is every data point.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | 0 |

##### -BeginTime
This is is Get-Date object and we format it for you.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -EndTime
Specifies end time for copying last record from the input file. This is is Get-Date object and we format it for you.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -ConfigPath
Specifies the pathname of the settings file that contains command-line parameters.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -Summary
If this switch is enabled, the performance counters and time ranges of log files specified in the input file will be displayed.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | False |

##### -InputObject
Accepts the output of Get-DbaPfDataCollector and Get-DbaPfDataCollectorSet as input via the pipeline.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | true (ByValue) |
| Default Value |  |

##### -Multithread
If this switch is enabled, processing will be done in parallel. This may speed up large batches or large files.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | False |

##### -AllTime
If this switch is enabled and a datacollector or datacollectorset is passed in via the pipeline, collects all logs, not just the latest.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | False |

##### -Raw
If this switch is enabled, the results of the DOS command instead of Get-ChildItem will be displayed. This does not run in parallel.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | False |

##### -EnableException
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | False |



&nbsp;

Want to see the source code for this command? Check out [Invoke-DbaPfRelog](https://github.com/sqlcollaborative/dbatools/blob/master/functions/Invoke-DbaPfRelog.ps1) on GitHub.
<br>
Want to see the Bill Of Health for this command? Check out [Invoke-DbaPfRelog](https://sqlcollaborative.github.io/boh#Invoke-DbaPfRelog).