Healthcheck #133

mrfuxi · 2017-07-25T13:41:55Z

Would it be possible to implement Docker's HEALTHCHECK command?

twright-msft · 2017-07-25T17:02:25Z

Yeah, now that we have sqlcmd in the image this should be much easier. I'll put it on our backlog internally. If you need something sooner, I'd suggest creating your own image FROM ours and specifying a HEALTCHECK that uses sqlcmd with -q to execute a simple query periodically like 'SELECT 1'.

sangohan · 2017-09-07T05:31:37Z

I too am having an issue where the docker image crashes, but continues to output lines of logging, which prevents my internal hung-build-killer tool to detect that something went wrong.

2017-09-06 09:50:11.21 spid90 Timeout occurred while waiting for latch: class 'LOG_MANAGER', id 00000005ED740BB0, type 4, Task 0x00000005EB49B088 : 0, waittime 71400 seconds, flags 0x1a, owning task 0x00000005EB492CA8. Continuing to wait.
2017-09-06 09:50:25.26 spid89 Timeout occurred while waiting for latch: class 'LOG_MANAGER', id 00000005ED740BB0, type 4, Task 0x00000005EEDE7088 : 0, waittime 71400 seconds, flags 0x1a, owning task 0x00000005EB492CA8. Continuing to wait.
2017-09-06 09:51:25.25 spid84 Timeout occurred while waiting for latch: class 'LOG_MANAGER', id 00000005ED740BB0, type 4, Task 0x00000005E800DC28 : 0, waittime 71400 seconds, flags 0x1a, owning task 0x00000005EB492CA8. Continuing to wait.

having a healthcheck mechanism in the case of this would be great.

manicmonkey · 2017-11-15T15:01:35Z

I get the same crash / error after using netcat to ascertain when the process has started listening on port 1433

axelfontaine · 2018-01-26T14:17:33Z

This is super useful in order to avoid having to develop custom poll and wait script to check whether the DB is up in order to be able to start other activities.

krkabol · 2018-04-19T07:16:44Z

Dockerfile:

FROM microsoft/mssql-server-linux
HEALTHCHECK --interval=10s --timeout=3s --start-period=10s --retries=10 \
    CMD sqlcmd -S localhost -U sa -P ${SA_PASSWORD} -Q "SELECT 1" || exit 1

djechelon · 2019-12-03T13:23:56Z

It should be

CMD /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P ${SA_PASSWORD} -Q "SELECT 1" || exit 1

Because sqlcmd is not on PATH

raczeja · 2020-03-18T07:07:50Z

Is there a simple way to use HEALTHCHECK?
I use this piece of code, but maybe you can advise something simpler?
https://github.com/ObjectivityLtd/DBTestCompare/blob/master/restoreBackup.ps1#L7
do { $JSON=docker inspect --format='{{json .State.Health}}' sqlserver-container | Out-String | ConvertFrom-Json Write-Host HEALTHCHECK: $JSON.Status.ToString() sqlserver-container Start-Sleep -s 10 } Until ($JSON.Status.ToString() -eq 'healthy')

tinohager · 2020-05-03T18:55:25Z

services:
    db:
        image: "mcr.microsoft.com/mssql/server:2019-latest"
        environment:
            SA_PASSWORD: "Secure-Password.1234"
            ACCEPT_EULA: "Y"
        healthcheck:
            test: /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P "$$SA_PASSWORD" -Q "SELECT 1" || exit 1
            interval: 10s
            timeout: 3s
            retries: 10
            start_period: 10s

Update 2024

services:
    db:
        image: "mcr.microsoft.com/mssql/server:2019-latest"
        environment:
            SA_PASSWORD: "Secure-Password.1234"
            ACCEPT_EULA: "Y"
        healthcheck:
            test: /opt/mssql-tools18/bin/sqlcmd -C -S localhost -U sa -P "$$SA_PASSWORD" -Q "SELECT 1" || exit 1
            interval: 10s
            timeout: 3s
            retries: 10
            start_period: 10s

mrlioncub · 2021-03-11T05:42:26Z

Everything that is written above must be changed:
required with the option: -b
and I recommend using the option: -o /dev/null
in docker-compose.yaml

    healthcheck:
      test: /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P "$${SA_PASSWORD}" -Q "SELECT 1" -b -o /dev/null
      interval: 10s
      timeout: 3s
      retries: 10
      start_period: 10s

in Dockerfile:

HEALTHCHECK --interval=10s --timeout=3s --start-period=10s --retries=10 \
  CMD /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P $${SA_PASSWORD} -Q "SELECT 1" -b -o /dev/null

raschmitt · 2021-03-12T22:09:40Z

I'm curious here, why do we need to have exit 1 if sqlcmd -Q already has a built-in exit?

 -Q "cmdline query" (and exit)

https://docs.microsoft.com/en-us/sql/tools/sqlcmd-utility?view=sql-server-ver15#syntax

mrlioncub · 2021-03-13T15:16:05Z

Yes, exit 1 is not needed. Updated

neur0manc · 2021-06-22T13:52:39Z

These solution don't take into account that during database migration after an update, the database can be locked for several minutes. To the developers: Is it possible to take that into account? Does sql-server have an idiomatic way to determine that it is currently upgrading databases? Are you maybe working on a HEALTHCHECK command that is working with that scenario?

The best idea so far to work around this is to add --start-period=10m to the healthcheck.

leomelzer · 2021-07-20T12:22:08Z

Thanks @mrlioncub 🎉 I was searching for a solution for using the image in a GitHub Action and the healthcheck wasn't working...thankfully Google found your comment.

Passing -b -o /dev/null solved the issue for me. Sharing for future reference:

name: CI

on: push

jobs:
    test:
        name: Test
        runs-on: ubuntu-latest
        env:
            DB_USER: SA
            DB_PASSWORD: yourStrongP@ssword
            DB_NAME: your_db

        services:
            mssql:
                image: mcr.microsoft.com/mssql/server:2017-latest-ubuntu
                env:
                    ACCEPT_EULA: Y
                    SA_PASSWORD: ${{ env.DB_PASSWORD }}
                    MSSQL_PID: Express
                    DB_USER: ${{ env.DB_USER }}
                    DB_NAME: ${{ env.DB_NAME }}
                ports:
                    - 1433/tcp
                options: >-
                    --health-cmd "/opt/mssql-tools/bin/sqlcmd -U $DB_USER -P $SA_PASSWORD -Q 'select 1' -b -o /dev/null"
                    --health-interval 60s
                    --health-timeout 30s
                    --health-start-period 20s
                    --health-retries 3

        steps:
            - name: Create Database
              run: |
                  docker exec $(docker ps -alq) /opt/mssql-tools/bin/sqlcmd -U "$DB_USER" -P "$DB_PASSWORD" -Q "CREATE DATABASE $DB_NAME;"

            - uses: actions/checkout@v2

            - name: Setup Node Package Cache
              uses: actions/cache@v2
              with:
                  path: ~/.npm
                  key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}

            - name: Install
              run: |
                  npm ci --prefer-offline --no-audit

            - name: Test
              env:
                  DB_HOST: localhost
                  DB_PORT: ${{ job.services.mssql.ports[1433] }}
                  DB_USER: ${{ env.DB_USER }}
                  DB_PASSWORD: ${{ env.DB_PASSWORD }}
                  DB_NAME: ${{ env.DB_NAME }}
              run: |
                  npm test

YoChen · 2022-05-13T12:17:26Z

yes ,I have the same problem,use these can't resolve. how to config sqlserver healthycheck?

See: microsoft/mssql-docker#133

ErcinDedeoglu · 2023-03-26T11:16:24Z

BEST PRACTICE


services:
  instance:
    container_name: sql-server-2022
    image: mcr.microsoft.com/mssql/server:2022-latest
    restart: unless-stopped
    environment:
      ACCEPT_EULA: Y
      MSSQL_SA_PASSWORD: SA-PASSWORD
      MSSQL_PID: Enterprise
    ports:
      - 2222:1433
    healthcheck:
      test: /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P "SA-PASSWORD" -Q "SELECT 1" -b -o /dev/null
      interval: 10s
      timeout: 3s
      retries: 10
      start_period: 10s
    volumes:
      - mssql:/var/opt/mssql
    networks:
      - internal

antman2 · 2023-05-23T05:49:14Z

I disagree with the "best practice" of using -o /dev/null in the parameters. If you do that then the healthcheck output as seen in docker container inspect <container_id> is an empty string - which can hide clues about which part of the network/SQL stack is responsible for the failure.

If you do not include -o /dev/null in the parameters then you can see the actual error message as demonstrated in this snippet:

{
    "Health": {
        "Status": "unhealthy",
        "FailingStreak": 1,
        "Log": [
            {
                "Start": "2023-05-23T05:41:54.699717693Z",
                "End": "2023-05-23T05:41:54.827199774Z",
                "ExitCode": 1,
                "Output": "Msg 102, Level 15, State 1, Server 0999316e8300, Line 1\nIncorrect syntax near 'Error'.\n"
            }
        ]
    }
}

she-trifork · 2024-01-30T15:15:49Z

Hi,
I'm curious why it's best practice to execute a command with a clear text password that can be read from anywhere on the system e.g. with ps -a. Is there really no other option to ask the mssql process if it's running and at good health? Something like pgrep -f /opt/mssql/bin/sqlservr && exit 1 || exit 0 would at least be more secure, but presumably not as reliable.

fabiang · 2024-01-30T17:38:11Z

Hi, I'm curious why it's best practice to execute a command with a clear text password that can be read from anywhere on the system e.g. with ps -a. Is there really no other option to ask the mssql process if it's running and at good health? Something like pgrep -f /opt/mssql/bin/sqlservr && exit 1 || exit 0 would at least be more secure, but presumably not as reliable.

You have two options here:

a) use SQLCMDPASSWORD environment variable to pass the password
b) use the new go-sqlcmd tool, which allows you to define a config file, from where it can read the password.

clearwaterstream · 2024-02-28T17:30:21Z

since /opt/mssql-tools/bin/sqlcmd is NOT available on linux/arm64 (Mac M1, M2, etc) for mcr.microsoft.com/azure-sql-edge:latest

Can someone please provide a command that will work with whatever flavour of linux mcr.microsoft.com/azure-sql-edge:latest is using? This way no additional tools need to be installed, if possible.

I realize it's a different image, but the ask is fairly generic: how does one test for port being open, and accepting connections w/o using specific tooling such as sqlcmd

k3n · 2024-03-13T20:05:22Z

@clearwaterstream Taking inspiration from StackOverflow [1], I was able to use this since timeout is available in the image:

healthcheck:
  test: timeout 1 bash -c 'cat < /dev/null > /dev/tcp/127.0.0.1/1433'

https://stackoverflow.com/a/19866239/84473

filipopo · 2024-11-24T20:57:36Z

I want to give my own version using SQLCMDPASSWORD environment...
/opt/mssql-tools*/bin/sqlcmd -C -S localhost -U sa -Q "SELECT 1" -b -o /dev/null

belgattitude · 2025-01-03T02:05:35Z

I've created a gist with latest mmsql (mcr.microsoft.com/mssql/server:2022-CU16-ubuntu-22.04) for those interested

https://gist.github.com/belgattitude/9979e5501d72ffa90c9460597dee8dca

# Create and .env.mssql.development file with
#
# # @link https://learn.microsoft.com/en-us/sql/relational-databases/collations/collation-and-unicode-support?view=sql-server-ver15#utf8
# MSSQL_COLLATION=LATIN1_GENERAL_100_CI_AS_SC_UTF8
# MSSQL_SA_PASSWORD=AStrongPwd1456
# @link https://hub.docker.com/r/microsoft/mssql-server
# MSSQL_PID=Developer
# ACCEPT_EULA=Y
# TZ=Etc/UTC
#

name: example-mssql

services:
  mssql:
    container_name: example-mssql
    image: mcr.microsoft.com/mssql/server:2022-CU16-ubuntu-22.04
    # Only when docker is running as "root".
    cap_add: ['SYS_PTRACE']
    ports:
      - '1433:1433'
    env_file:
      - .env.mssql.development
    networks:
      - example-mssql
    volumes:
      - example-mssql:/var/opt/mssql:rw
    restart: no
    healthcheck:
      # -C disable checks for encryption
      test: /opt/mssql-tools18/bin/sqlcmd -S localhost -C -U sa -P "$$MSSQL_SA_PASSWORD" -Q "SELECT 1" -b -o /dev/null
      interval: 1s
      timeout: 30s
      retries: 30
      start_period: 5s

volumes:
  example-mssql:

networks:
  example-mssql:
    driver: bridge
    enable_ipv6: false

stevenobird · 2025-01-04T14:04:20Z

I've created a gist with latest mmsql (mcr.microsoft.com/mssql/server:2022-CU16-ubuntu-22.04) for those interested

https://gist.github.com/belgattitude/9979e5501d72ffa90c9460597dee8dca

If possible, be compliant to the correct syntax for CMD or CMD-SHELL, see docker compose reference or SHELL/EXEC in Dockerfile reference, which is the preferred way:

    test: ["CMD-SHELL", "/opt/mssql-tools18/bin/sqlcmd -C -S localhost -U sa -P $$MSSQL_SA_PASSWORD -Q 'SELECT 1'"]

or, if no variable subsitution is needed:

    test: ["CMD", "/opt/mssql-tools18/bin/sqlcmd", "-C", "-S", "localhost", "-U", "sa", "-P", "<YourStrong@Passw0rd>", "-Q", "SELECT 1"]

Nothing wrong with your solution, I'm justing being picky here :)

belgattitude · 2025-01-06T08:55:35Z

If possible, be compliant to the correct syntax for CMD or CMD-SHELL, see docker compose reference or SHELL/EXEC in Dockerfile reference, which is the preferred way:

I couldn't make it work but I'm interested if you have an example, tried:

test: ["CMD", "/opt/mssql-tools18/bin/sqlcmd", "-C", "-S", "localhost", "-U", "sa", "-P", "echo $MSSQL_SA_PASSWORD", "-Q", "SELECT 1", "-b"]

stevenobird · 2025-01-06T23:27:44Z

If possible, be compliant to the correct syntax for CMD or CMD-SHELL, see docker compose reference or SHELL/EXEC in Dockerfile reference, which is the preferred way:

I couldn't make it work but I'm interested if you have an example, tried:
test: ["CMD", "/opt/mssql-tools18/bin/sqlcmd", "-C", "-S", "localhost", "-U", "sa", "-P", "echo $MSSQL_SA_PASSWORD", "-Q", "SELECT 1", "-b"]

If you're going for variable substitution, you'll need to use CMD-SHELL syntax.

firmin-kaman · 2025-03-06T19:00:09Z

This had worked for me 👍

services:
sqlserver:
image: mcr.microsoft.com/mssql/server:2022-latest
container_name: sqlserver
environment:
SA_PASSWORD: "YourOwnPassword123"
ACCEPT_EULA: "Y"
ports:
- "1433:1433"
networks:
- liquibase-network
- dataiku-network
healthcheck:
test: ["CMD-SHELL", "/opt/mssql-tools18/bin/sqlcmd -S 127.0.0.1 -U sa -P YourOwnPassword123 -Q "SELECT 1" -C"]
interval: 10s
timeout: 5s
retries: 5
start_period: 20s

perrysk-msft added the mssql-server-linux label Oct 13, 2017

filiphr mentioned this issue May 19, 2021

Health check not working with docker gvenzl/oci-oracle-xe#19

Closed

jnahmias added a commit to jnahmias/mssql-gh-action-test that referenced this issue Aug 17, 2022

integrate db startup health check into service definition

30f876b

See: microsoft/mssql-docker#133

candiduslynx mentioned this issue Jan 10, 2023

feat(mssql): Microsoft SQL Server destination cloudquery/cloudquery#6417

Merged

robertlagrant mentioned this issue Apr 18, 2023

Add Docker Compose files for simplified local testing DependencyTrack/dependency-track#2675

Merged

1 task

jankatins mentioned this issue Apr 26, 2024

refactor(core): Standardize configuration and readiness steps in container lifecycle testcontainers/testcontainers-python#527

Draft

trentm mentioned this issue Jul 23, 2024

mssql tests are failing in CI because a recent mcr.microsoft.com/mssql/server docker image release breaks our healthcheck elastic/apm-agent-nodejs#4147

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Healthcheck #133

Healthcheck #133

mrfuxi commented Jul 25, 2017

twright-msft commented Jul 25, 2017

sangohan commented Sep 7, 2017

manicmonkey commented Nov 15, 2017 •

edited

Loading

axelfontaine commented Jan 26, 2018

krkabol commented Apr 19, 2018

djechelon commented Dec 3, 2019

raczeja commented Mar 18, 2020 •

edited

Loading

tinohager commented May 3, 2020 •

edited

Loading

mrlioncub commented Mar 11, 2021 •

edited

Loading

raschmitt commented Mar 12, 2021

mrlioncub commented Mar 13, 2021

neur0manc commented Jun 22, 2021

leomelzer commented Jul 20, 2021

YoChen commented May 13, 2022

ErcinDedeoglu commented Mar 26, 2023 •

edited

Loading

antman2 commented May 23, 2023

she-trifork commented Jan 30, 2024 •

edited

Loading

fabiang commented Jan 30, 2024 •

edited

Loading

clearwaterstream commented Feb 28, 2024 •

edited

Loading

k3n commented Mar 13, 2024

filipopo commented Nov 24, 2024

belgattitude commented Jan 3, 2025 •

edited

Loading

stevenobird commented Jan 4, 2025 •

edited

Loading

belgattitude commented Jan 6, 2025

stevenobird commented Jan 6, 2025

firmin-kaman commented Mar 6, 2025

Healthcheck #133

Healthcheck #133

Comments

mrfuxi commented Jul 25, 2017

twright-msft commented Jul 25, 2017

sangohan commented Sep 7, 2017

manicmonkey commented Nov 15, 2017 • edited Loading

axelfontaine commented Jan 26, 2018

krkabol commented Apr 19, 2018

djechelon commented Dec 3, 2019

raczeja commented Mar 18, 2020 • edited Loading

tinohager commented May 3, 2020 • edited Loading

mrlioncub commented Mar 11, 2021 • edited Loading

raschmitt commented Mar 12, 2021

mrlioncub commented Mar 13, 2021

neur0manc commented Jun 22, 2021

leomelzer commented Jul 20, 2021

YoChen commented May 13, 2022

ErcinDedeoglu commented Mar 26, 2023 • edited Loading

BEST PRACTICE

antman2 commented May 23, 2023

she-trifork commented Jan 30, 2024 • edited Loading

fabiang commented Jan 30, 2024 • edited Loading

clearwaterstream commented Feb 28, 2024 • edited Loading

k3n commented Mar 13, 2024

filipopo commented Nov 24, 2024

belgattitude commented Jan 3, 2025 • edited Loading

stevenobird commented Jan 4, 2025 • edited Loading

belgattitude commented Jan 6, 2025

stevenobird commented Jan 6, 2025

firmin-kaman commented Mar 6, 2025

manicmonkey commented Nov 15, 2017 •

edited

Loading

raczeja commented Mar 18, 2020 •

edited

Loading

tinohager commented May 3, 2020 •

edited

Loading

mrlioncub commented Mar 11, 2021 •

edited

Loading

ErcinDedeoglu commented Mar 26, 2023 •

edited

Loading

she-trifork commented Jan 30, 2024 •

edited

Loading

fabiang commented Jan 30, 2024 •

edited

Loading

clearwaterstream commented Feb 28, 2024 •

edited

Loading

belgattitude commented Jan 3, 2025 •

edited

Loading

stevenobird commented Jan 4, 2025 •

edited

Loading